Skip to content
Snippets Groups Projects
Commit 51f631e0 authored by Francois Bleibel's avatar Francois Bleibel
Browse files

Updated documentation

parent 1492233c
No related branches found
No related tags found
No related merge requests found
...@@ -135,26 +135,32 @@ IEEE Trans. on Robotics, 23(1):60-72, February 2007 ...@@ -135,26 +135,32 @@ IEEE Trans. on Robotics, 23(1):60-72, February 2007
\defgroup dgraph Core classes and objects \defgroup dgraph Core classes and objects
\defgroup signals Signals
\ingroup dgraph \ingroup dgraph
@{ @{
Classes, entities and binaries that make up the core of the dynamic-graph library are listed here. Classes, entities and binaries that make up the core of the dynamic-graph library are listed here.
@} @}
\defgroup signals Signals
\ingroup signals \ingroup signals
@{ @{
This part provides the mechanism to transfer information This part provides the mechanism to transfer information
from one entity to another. There are three main types of signals, from one entity to another. There are three main types of signals,
all deriving from the common class dynamicgraph::SignalBase : all deriving from the common class dynamicgraph::SignalBase :
\li dynamicgraph::Signal \li dynamicgraph::Signal : a "normal" signal, passing data around \bby \bvalue
\li dynamicgraph::SignalPtr \li dynamicgraph::SignalPtr : a signal used for efficient passing of large data, by reference (or rather, C pointers)*
\li dynamicgraph::SignalTimeDependent \li dynamicgraph::SignalTimeDependent : a signal that enforces a time dependence between other signals,
making sure its inputs are up to date, using a incrementing time tick as reference.
\n* Note: this may cause a problem if this package is used in a multithreaded program.
Signals can be grouped together using dynamicgraph::SignalArray. Signals can be grouped together using dynamicgraph::SignalArray.
Signals implement a caching mechanism by storing the last computation time tick. Signals implement a caching mechanism by storing the last computation time tick.
Signals can be plugged into one another or set through shell commands.
Signals can be plugged ("plug" script command) into one another or set through shell commands.
@} @}
\namespace dynamicgraph This is the namespace where every object and class of this library is located. \namespace dynamicgraph This is the namespace where every object and class of this library is located.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment