niklas/ros2_tracing
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'update-design-doc-toc' into 'master'

Browse source 
Update table of content for design document

See merge request micro-ROS/ros_tracing/ros2_tracing!126
This commit is contained in:
Christophe Bedard 2020-01-01 03:01:00 +00:00
commit 10caca0b69
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/design_ros_2.md
View file

@ -32,7 +32,9 @@ Design document for ROS 2 tracing, instrumentation, and analysis effort.
2. [Notes on client libraries](#notes-on-client-libraries) 2. [Notes on client libraries](#notes-on-client-libraries)
3. [ROS 1/2 compatibility](#ros-12-compatibility) 3. [ROS 1/2 compatibility](#ros-12-compatibility)
6. [Tools packages](#tools-packages) 6. [Tools packages](#tools-packages)
7. [Analysis architecture](#analysis-architecture) 7. [Analysis](#analysis)
1. [Analysis design](#analysis-design)
1. [Analysis architecture](#analysis-architecture)
## Introduction ## Introduction
@ -649,7 +651,7 @@ tracetools_analysis <-- ros2trace_analysis
## Analysis ## Analysis
### Design ### Analysis design
Generally, for a given trace data analysis objective, the following classes are extended: `EventHandler`, `DataModel`, and `DataModelUtil`. Generally, for a given trace data analysis objective, the following classes are extended: `EventHandler`, `DataModel`, and `DataModelUtil`.
@ -657,7 +659,7 @@ A user/developer can implement an `EventHandler`, which defines callbacks for sp
Meaningful data can be extracted from the `DataModel`. However, a `DataModelUtil` can provide common utility functions so that users don't have to re-write them. This meaningful output data can then be presented through a Jupyter notebook (e.g. plots) or a normal Python script (e.g. tables). Meaningful data can be extracted from the `DataModel`. However, a `DataModelUtil` can provide common utility functions so that users don't have to re-write them. This meaningful output data can then be presented through a Jupyter notebook (e.g. plots) or a normal Python script (e.g. tables).
### Architecture ### Analysis architecture
With profiling as an example implementation: With profiling as an example implementation: