Tracer plug-in main class. More...

#include <dynamic-graph/tracer.h>

Inheritance diagram for dynamicgraph::Tracer:

Collaboration diagram for dynamicgraph::Tracer:

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::Command *	getNewStyleCommand (const std::string &cmdName)

SignalMap	getSignalMap () const

Logger &	logger ()

Logger const &	logger () const

void	sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
	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

◆ FileList

typedef std::list<std::ostream *> dynamicgraph::Tracer::FileList

◆ NameList

typedef std::list<std::string> dynamicgraph::Tracer::NameList

◆ SignalList

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

protected

Member Enumeration Documentation

◆ TraceStyle

enum dynamicgraph::Tracer::TraceStyle

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

◆ Tracer()

dynamicgraph::Tracer::Tracer ( const std::string n )

◆ ~Tracer()

virtual dynamicgraph::Tracer::~Tracer ( )

inlinevirtual

Member Function Documentation

◆ addSignalToTrace()

void dynamicgraph::Tracer::addSignalToTrace	(	const SignalBase< int > &	sig,
		const std::string &	filename = `""`
	)

◆ addSignalToTraceByName()

void dynamicgraph::Tracer::addSignalToTraceByName	(	const std::string &	signame,
		const std::string &	filename = `""`
	)

◆ clearSignalToTrace()

void dynamicgraph::Tracer::clearSignalToTrace ( )

◆ closeFiles()

virtual void dynamicgraph::Tracer::closeFiles ( )

virtual

Reimplemented in dynamicgraph::TracerRealTime.

◆ display()

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

virtual

Reimplemented from dynamicgraph::Entity.

◆ getFrequency()

double dynamicgraph::Tracer::getFrequency ( )

inline

◆ getTraceStyle()

TraceStyle dynamicgraph::Tracer::getTraceStyle ( )

inline

◆ openFile()

virtual void dynamicgraph::Tracer::openFile	(	const SignalBase< int > &	sig,
		const std::string &	filename
	)

protectedvirtual

Reimplemented in dynamicgraph::TracerRealTime.

◆ openFiles()

void dynamicgraph::Tracer::openFiles	(	const std::string &	rootdir,
		const std::string &	basename,
		const std::string &	suffix
	)

◆ record()

void dynamicgraph::Tracer::record ( )

◆ recordSignal()

virtual void dynamicgraph::Tracer::recordSignal	(	std::ostream &	os,
		const SignalBase< int > &	sig
	)

virtual

Reimplemented in dynamicgraph::TracerRealTime.

◆ recordTrigger()

int& dynamicgraph::Tracer::recordTrigger	(	int &	dummy,
		const int &	time
	)

◆ setFrenquency()

void dynamicgraph::Tracer::setFrenquency ( const double & frqu )

inline

◆ setTraceStyle()

void dynamicgraph::Tracer::setTraceStyle ( const TraceStyle & style )

inline

◆ start()

void dynamicgraph::Tracer::start ( )

inline

◆ stop()

void dynamicgraph::Tracer::stop ( )

inline

◆ trace()

virtual void dynamicgraph::Tracer::trace ( )

virtual

Reimplemented in dynamicgraph::TracerRealTime.

Friends And Related Function Documentation

◆ operator<<

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

friend

Member Data Documentation

◆ basename

std::string dynamicgraph::Tracer::basename

◆ files

FileList dynamicgraph::Tracer::files

◆ frequency

double dynamicgraph::Tracer::frequency

◆ names

NameList dynamicgraph::Tracer::names

◆ namesSet

bool dynamicgraph::Tracer::namesSet

◆ play

bool dynamicgraph::Tracer::play

◆ rootdir

std::string dynamicgraph::Tracer::rootdir

◆ suffix

std::string dynamicgraph::Tracer::suffix

◆ timeStart

int dynamicgraph::Tracer::timeStart

◆ toTraceSignals

SignalList dynamicgraph::Tracer::toTraceSignals

protected

◆ TRACE_STYLE_DEFAULT

const TraceStyle dynamicgraph::Tracer::TRACE_STYLE_DEFAULT = EACH_TIME

static

◆ traceStyle

TraceStyle dynamicgraph::Tracer::traceStyle

◆ triger

SignalTimeDependent<int, int> dynamicgraph::Tracer::triger

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ FileList

◆ NameList

◆ SignalList

Member Enumeration Documentation

◆ TraceStyle

Constructor & Destructor Documentation

◆ Tracer()

◆ ~Tracer()

Member Function Documentation

◆ addSignalToTrace()

◆ addSignalToTraceByName()

◆ clearSignalToTrace()

◆ closeFiles()

◆ display()

◆ getFrequency()

◆ getTraceStyle()

◆ openFile()

◆ openFiles()

◆ record()

◆ recordSignal()

◆ recordTrigger()

◆ setFrenquency()

◆ setTraceStyle()

◆ start()

◆ stop()

◆ trace()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ basename

◆ files

◆ frequency

◆ names

◆ namesSet

◆ play

◆ rootdir

◆ suffix

◆ timeStart

◆ toTraceSignals

◆ TRACE_STYLE_DEFAULT

◆ traceStyle

◆ triger