dynamicgraph::Tracer Class Reference

Tracer plug-in main class. More...

#include <dynamic-graph/tracer.h>

Inheritance diagram for dynamicgraph::Tracer:
[legend]
Collaboration diagram for dynamicgraph::Tracer:
[legend]

Public Types

enum  TraceStyle {
  WHEN_SAID,
  EACH_TIME,
  FREQUENTLY
}
 
typedef std::list< std::ostream * > FileList
 
typedef std::list< std::string > NameList
 
- Public Types inherited from dynamicgraph::Entity
typedef std::map< std::string, SignalBase< int > * > SignalMap
 
typedef std::map< const std::string, command::Command * > CommandMap_t
 

Public Member Functions

 Tracer (const std::string n)
 
virtual ~Tracer ()
 
void addSignalToTrace (const SignalBase< int > &sig, const std::string &filename="")
 
void addSignalToTraceByName (const std::string &signame, const std::string &filename="")
 
void clearSignalToTrace ()
 
void openFiles (const std::string &rootdir, const std::string &basename, const std::string &suffix)
 
virtual void closeFiles ()
 
void setTraceStyle (const TraceStyle &style)
 
TraceStyle getTraceStyle ()
 
void setFrenquency (const double &frqu)
 
double getFrequency ()
 
void record ()
 
virtual void recordSignal (std::ostream &os, const SignalBase< int > &sig)
 
int & recordTrigger (int &dummy, const int &time)
 
virtual void trace ()
 
void start ()
 
void stop ()
 
void display (std::ostream &os) const
 
- Public Member Functions inherited from dynamicgraph::Entity
 Entity (const std::string &name)
 
virtual ~Entity ()
 
const std::string & getName () const
 
virtual const std::string & getClassName () const
 
virtual std::string getDocString () const
 
bool hasSignal (const std::string &signame) const
 
SignalBase< int > & getSignal (const std::string &signalName)
 
const SignalBase< int > & getSignal (const std::string &signalName) const
 
std::ostream & displaySignalList (std::ostream &os) const
 
virtual std::ostream & writeGraph (std::ostream &os) const
 
virtual std::ostream & writeCompletionList (std::ostream &os) const
 
virtual SignalBase< int > * test ()
 
virtual void test2 (SignalBase< int > *)
 
const std::string & getCommandList () const
 
CommandMap_t getNewStyleCommandMap ()
 
command::CommandgetNewStyleCommand (const std::string &cmdName)
 
SignalMap getSignalMap () const
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const char *file="", int line=0)
 Send messages msg with level t. More...
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 Specify the verbosity level of the logger. More...
 
LoggerVerbosity getLoggerVerbosityLevel ()
 Get the logger's verbosity level. More...
 
bool setTimeSample (double t)
 Set the time sample. More...
 
double getTimeSample ()
 Get the time sample. More...
 
bool setStreamPrintPeriod (double t)
 Set the period of the stream period. More...
 
double getStreamPrintPeriod ()
 Get the period of the stream period. More...
 

Public Attributes

TraceStyle traceStyle
 
double frequency
 
std::string basename
 
std::string suffix
 
std::string rootdir
 
bool namesSet
 
FileList files
 
NameList names
 
bool play
 
int timeStart
 
SignalTimeDependent< int, int > triger
 

Static Public Attributes

static const TraceStyle TRACE_STYLE_DEFAULT = EACH_TIME
 

Protected Types

typedef std::list< const SignalBase< int > * > SignalList
 

Protected Member Functions

virtual void openFile (const SignalBase< int > &sig, const std::string &filename)
 
- Protected Member Functions inherited from dynamicgraph::Entity
void addCommand (const std::string &name, command::Command *command)
 
void entityRegistration ()
 
void entityDeregistration ()
 
void signalRegistration (const SignalArray< int > &signals)
 
void signalDeregistration (const std::string &name)
 

Protected Attributes

SignalList toTraceSignals
 
- Protected Attributes inherited from dynamicgraph::Entity
std::string name
 
SignalMap signalMap
 
CommandMap_t commandMap
 
Logger logger_
 

Friends

DG_TRACER_DLLAPI friend std::ostream & operator<< (std::ostream &os, const Tracer &t)
 

Detailed Description

Tracer plug-in main class.

Member Typedef Documentation

typedef std::list<std::ostream *> dynamicgraph::Tracer::FileList
typedef std::list<std::string> dynamicgraph::Tracer::NameList
typedef std::list<const SignalBase<int> *> dynamicgraph::Tracer::SignalList
protected

Member Enumeration Documentation

Enumerator
WHEN_SAID 

Record, then trace to file only when said to.

EACH_TIME 

Record and trace to file immediately.

FREQUENTLY 

Record X time then trace (X is tuned by setFrenquence () ).

Constructor & Destructor Documentation

dynamicgraph::Tracer::Tracer ( const std::string  n)
virtual dynamicgraph::Tracer::~Tracer ( )
inlinevirtual

Member Function Documentation

void dynamicgraph::Tracer::addSignalToTrace ( const SignalBase< int > &  sig,
const std::string &  filename = "" 
)
void dynamicgraph::Tracer::addSignalToTraceByName ( const std::string &  signame,
const std::string &  filename = "" 
)
void dynamicgraph::Tracer::clearSignalToTrace ( )
virtual void dynamicgraph::Tracer::closeFiles ( )
virtual

Reimplemented in dynamicgraph::TracerRealTime.

void dynamicgraph::Tracer::display ( std::ostream &  os) const
virtual

Reimplemented from dynamicgraph::Entity.

double dynamicgraph::Tracer::getFrequency ( )
inline
TraceStyle dynamicgraph::Tracer::getTraceStyle ( )
inline
virtual void dynamicgraph::Tracer::openFile ( const SignalBase< int > &  sig,
const std::string &  filename 
)
protectedvirtual

Reimplemented in dynamicgraph::TracerRealTime.

void dynamicgraph::Tracer::openFiles ( const std::string &  rootdir,
const std::string &  basename,
const std::string &  suffix 
)
void dynamicgraph::Tracer::record ( )
virtual void dynamicgraph::Tracer::recordSignal ( std::ostream &  os,
const SignalBase< int > &  sig 
)
virtual

Reimplemented in dynamicgraph::TracerRealTime.

int& dynamicgraph::Tracer::recordTrigger ( int &  dummy,
const int &  time 
)
void dynamicgraph::Tracer::setFrenquency ( const double &  frqu)
inline
void dynamicgraph::Tracer::setTraceStyle ( const TraceStyle style)
inline
void dynamicgraph::Tracer::start ( )
inline
void dynamicgraph::Tracer::stop ( )
inline
virtual void dynamicgraph::Tracer::trace ( )
virtual

Reimplemented in dynamicgraph::TracerRealTime.

Friends And Related Function Documentation

DG_TRACER_DLLAPI friend std::ostream& operator<< ( std::ostream &  os,
const Tracer t 
)
friend

Member Data Documentation

std::string dynamicgraph::Tracer::basename
FileList dynamicgraph::Tracer::files
double dynamicgraph::Tracer::frequency
NameList dynamicgraph::Tracer::names
bool dynamicgraph::Tracer::namesSet
bool dynamicgraph::Tracer::play
std::string dynamicgraph::Tracer::rootdir
std::string dynamicgraph::Tracer::suffix
int dynamicgraph::Tracer::timeStart
SignalList dynamicgraph::Tracer::toTraceSignals
protected
const TraceStyle dynamicgraph::Tracer::TRACE_STYLE_DEFAULT = EACH_TIME
static
TraceStyle dynamicgraph::Tracer::traceStyle
SignalTimeDependent<int, int> dynamicgraph::Tracer::triger