dynamicgraph Namespace Reference

This is the namespace where every object and class of this library is located. More...

Namespaces

 command
 
 CPU
 

Classes

class  DebugTrace
 Logging class. More...
 
class  DefaultCastRegisterer
 This class can be used to register default casts, i.e. More...
 
class  Entity
 This class represents an entity, i.e. More...
 
struct  EntityHelper
 
class  EntityRegisterer
 This class automatically register an Entity to the global factory at initialization and unregister it during instance destruction. More...
 
class  ExceptionAbstract
 Abstract root class for all dynamic-graph exceptions. More...
 
class  ExceptionFactory
 Generic error class. More...
 
class  ExceptionSignal
 Exceptions raised when an error related to signals happen. More...
 
class  ExceptionTraces
 Exceptions raised when an error related to traces happen. More...
 
class  FactoryStorage
 Provides a way to create Entity objects from their class name. More...
 
class  Logger
 Class for logging messages. More...
 
class  LoggerIOStream
 Write to an ostream object. More...
 
class  LoggerStream
 Stream for the real-time logger. More...
 
class  OutStringStream
 Stream for the tracer real-time. More...
 
class  PoolStorage
 Singleton that keeps track of all the entities. More...
 
class  RealTimeLogger
 Main class of the real-time logger. More...
 
class  Signal
 Signals link I/O ports of entities. They can be constant-valued signals, or copy the value of a heap variable, or evaluated as a function. See SignalPtr and SignalTimeDependent for other types of signals, and SignalArray for a way of grouping them. More...
 
class  SignalArray
 TODO. More...
 
class  SignalArray_const
 TODO. More...
 
class  SignalBase
 The base class for signals: not to be used as such. More...
 
class  SignalCast
 
class  SignalCaster
 This singleton class allows serialization of a number of objects into (disp) and from (cast) std i/o streams. More...
 
class  SignalCastRegisterer
 The SignalCast registerer class. More...
 
class  SignalPtr
 This is the only type of signal that can be plugged to, using the plug () command. More...
 
class  SignalTimeDependent
 A type of signal that enforces a time dependency between other signals, making sure its inputs are up to date on access, using a incrementing time tick as reference. More...
 
class  TimeDependency
 A helper class for setting and specifying dependencies between signals. More...
 
class  Tracer
 Tracer plug-in main class. More...
 
class  TracerRealTime
 Main class of the tracer real-time plug-in. More...
 

Typedefs

typedef Eigen::MatrixXd Matrix
 
typedef Eigen::VectorXd Vector
 
typedef boost::shared_ptr< LoggerStreamLoggerStreamPtr_t
 

Enumerations

enum  MsgType {
  MSG_TYPE_TYPE_BITS = 1 << 0 | 1 << 1 | 1 << 2 | 1 << 3,
  MSG_TYPE_STREAM_BIT = 1 << 4,
  MSG_TYPE_DEBUG = 1 << 3,
  MSG_TYPE_INFO = 1 << 2,
  MSG_TYPE_WARNING = 1 << 1,
  MSG_TYPE_ERROR = 1 << 0,
  MSG_TYPE_DEBUG_STREAM = MSG_TYPE_DEBUG | MSG_TYPE_STREAM_BIT,
  MSG_TYPE_INFO_STREAM = MSG_TYPE_INFO | MSG_TYPE_STREAM_BIT,
  MSG_TYPE_WARNING_STREAM = MSG_TYPE_WARNING | MSG_TYPE_STREAM_BIT,
  MSG_TYPE_ERROR_STREAM = MSG_TYPE_ERROR | MSG_TYPE_STREAM_BIT
}
 Enum representing the different kind of messages. More...
 
enum  LoggerVerbosity {
  VERBOSITY_ALL = MSG_TYPE_DEBUG,
  VERBOSITY_INFO_WARNING_ERROR = MSG_TYPE_INFO,
  VERBOSITY_WARNING_ERROR = MSG_TYPE_WARNING,
  VERBOSITY_ERROR = MSG_TYPE_ERROR,
  VERBOSITY_NONE = 0
}
 

Functions

std::ostream & __null_stream ()
 
DYNAMIC_GRAPH_DLLAPI std::ostream & operator<< (std::ostream &os, const dynamicgraph::Entity &ent)
 
template<typename T >
std::string toString (const T &v, const int precision=3, const int width=-1)
 
template<typename T >
std::string toString (const std::vector< T > &v, const int precision=3, const int width=-1, const std::string separator=", ")
 
template<typename T >
std::string toString (const Eigen::MatrixBase< T > &v, const int precision=3, const int width=-1, const std::string separator=", ")
 
PoolStorageg_pool ()
 
template<class Time >
SignalArray_const< Time > operator<< (const SignalBase< Time > &sig1, const SignalBase< Time > &sig2)
 
template<class Time >
SignalArray< Time > operator<< (SignalBase< Time > &sig1, SignalBase< Time > &sig2)
 
template<class Time >
std::ostream & operator<< (std::ostream &os, const SignalBase< Time > &sig)
 Forward to a virtual fonction. More...
 
template<typename T >
void signal_disp (const T &value, std::ostream &os)
 Global signal cast template (helper) functions. More...
 
template<typename T >
signal_cast (std::istringstream &iss)
 
template<typename T >
void signal_trace (const T &value, std::ostream &os)
 

Variables

DYNAMIC_GRAPH_DLLAPI DebugTrace dgDEBUGFLOW
 
DYNAMIC_GRAPH_DLLAPI DebugTrace dgERRORFLOW
 
DYNAMIC_GRAPH_DLLAPI SignalArray< int > sotNOSIGNAL
 

Detailed Description

This is the namespace where every object and class of this library is located.

Todo:
These 3 headers should be removed.

Typedef Documentation

◆ LoggerStreamPtr_t

typedef boost::shared_ptr<LoggerStream> dynamicgraph::LoggerStreamPtr_t

◆ Matrix

typedef Eigen::MatrixXd dynamicgraph::Matrix

◆ Vector

typedef Eigen::VectorXd dynamicgraph::Vector

Enumeration Type Documentation

◆ LoggerVerbosity

Enumerator
VERBOSITY_ALL 
VERBOSITY_INFO_WARNING_ERROR 
VERBOSITY_WARNING_ERROR 
VERBOSITY_ERROR 
VERBOSITY_NONE 

◆ MsgType

Enum representing the different kind of messages.

Enumerator
MSG_TYPE_TYPE_BITS 
MSG_TYPE_STREAM_BIT 
MSG_TYPE_DEBUG 
MSG_TYPE_INFO 
MSG_TYPE_WARNING 
MSG_TYPE_ERROR 
MSG_TYPE_DEBUG_STREAM 
MSG_TYPE_INFO_STREAM 
MSG_TYPE_WARNING_STREAM 
MSG_TYPE_ERROR_STREAM 

Function Documentation

◆ __null_stream()

std::ostream& dynamicgraph::__null_stream ( )
inline

◆ g_pool()

PoolStorage& dynamicgraph::g_pool ( )
inline

◆ operator<<() [1/4]

DYNAMIC_GRAPH_DLLAPI std::ostream& dynamicgraph::operator<< ( std::ostream &  os,
const dynamicgraph::Entity ent 
)

◆ operator<<() [2/4]

template<class Time >
SignalArray<Time> dynamicgraph::operator<< ( SignalBase< Time > &  sig1,
SignalBase< Time > &  sig2 
)

◆ operator<<() [3/4]

template<class Time >
SignalArray_const<Time> dynamicgraph::operator<< ( const SignalBase< Time > &  sig1,
const SignalBase< Time > &  sig2 
)

◆ operator<<() [4/4]

template<class Time >
std::ostream& dynamicgraph::operator<< ( std::ostream &  os,
const SignalBase< Time > &  sig 
)

Forward to a virtual fonction.

◆ signal_cast()

template<typename T >
T dynamicgraph::signal_cast ( std::istringstream &  iss)

◆ signal_disp()

template<typename T >
void dynamicgraph::signal_disp ( const T &  value,
std::ostream &  os 
)

Global signal cast template (helper) functions.

Using these avoid using the typeid () operator and keeps the implementation details hidden.

References dynamicgraph::SignalCaster::disp(), and dynamicgraph::SignalCaster::getInstance().

◆ signal_trace()

template<typename T >
void dynamicgraph::signal_trace ( const T &  value,
std::ostream &  os 
)

◆ toString() [1/3]

template<typename T >
std::string dynamicgraph::toString ( const T &  v,
const int  precision = 3,
const int  width = -1 
)

◆ toString() [2/3]

template<typename T >
std::string dynamicgraph::toString ( const std::vector< T > &  v,
const int  precision = 3,
const int  width = -1,
const std::string  separator = ", " 
)

◆ toString() [3/3]

template<typename T >
std::string dynamicgraph::toString ( const Eigen::MatrixBase< T > &  v,
const int  precision = 3,
const int  width = -1,
const std::string  separator = ", " 
)

Variable Documentation

◆ dgDEBUGFLOW

DYNAMIC_GRAPH_DLLAPI DebugTrace dynamicgraph::dgDEBUGFLOW

◆ dgERRORFLOW

DYNAMIC_GRAPH_DLLAPI DebugTrace dynamicgraph::dgERRORFLOW

◆ sotNOSIGNAL

DYNAMIC_GRAPH_DLLAPI SignalArray<int> dynamicgraph::sotNOSIGNAL

Referenced by operator<<().