dynamicgraph::Entity Class Reference

This class represents an entity, i.e. More...

#include <dynamic-graph/entity.h>

Inheritance diagram for dynamicgraph::Entity:

Collaboration diagram for dynamicgraph::Entity:

Public Types
typedef std::map< std::string, SignalBase< int > * >	SignalMap
typedef std::map< const std::string, command::Command * >	CommandMap_t

Public Member Functions
	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 void	display (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 related methods
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...

Protected Member Functions
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
std::string	name
SignalMap	signalMap
CommandMap_t	commandMap
Logger	logger_

Detailed Description

This class represents an entity, i.e.

a generic computational unit that provides input and output signals.

These signals link the entities together to form a complete computation graph. To declare a new entity, please see the DYNAMICGRAPH_FACTORY_ENTITY_PLUGIN macro in factory.h.

Member Typedef Documentation

CommandMap_t

typedef std::map<const std::string, command::Command *> dynamicgraph::Entity::CommandMap_t

SignalMap

typedef std::map<std::string, SignalBase<int> *> dynamicgraph::Entity::SignalMap

Constructor & Destructor Documentation

Entity()

dynamicgraph::Entity::Entity ( const std::string &  name )

explicit

~Entity()

virtual dynamicgraph::Entity::~Entity ( )

virtual

Member Function Documentation

addCommand()

void dynamicgraph::Entity::addCommand ( const std::string &  name, command::Command *  command  )

protected

display()

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

virtual

Reimplemented in dynamicgraph::Tracer, and dynamicgraph::TracerRealTime.

displaySignalList()

std::ostream& dynamicgraph::Entity::displaySignalList

(

std::ostream &

os

)

const

entityDeregistration()

void dynamicgraph::Entity::entityDeregistration ( )

protected

entityRegistration()

void dynamicgraph::Entity::entityRegistration ( )

protected

getClassName()

virtual const std::string& dynamicgraph::Entity::getClassName ( ) const

inlinevirtual

getCommandList()

const std::string& dynamicgraph::Entity::getCommandList

(

)

const

getDocString()

virtual std::string dynamicgraph::Entity::getDocString ( ) const

virtual

getLoggerVerbosityLevel()

LoggerVerbosity dynamicgraph::Entity::getLoggerVerbosityLevel ( )

inline

Get the logger's verbosity level.

getName()

const std::string& dynamicgraph::Entity::getName ( ) const

inline

getNewStyleCommand()

command::Command* dynamicgraph::Entity::getNewStyleCommand

(

const std::string &

cmdName

)

getNewStyleCommandMap()

CommandMap_t dynamicgraph::Entity::getNewStyleCommandMap

(

)

getSignal() [1/2]

SignalBase<int>& dynamicgraph::Entity::getSignal

(

const std::string &

signalName

)

getSignal() [2/2]

const SignalBase<int>& dynamicgraph::Entity::getSignal

(

const std::string &

signalName

)

const

getSignalMap()

SignalMap dynamicgraph::Entity::getSignalMap

(

)

const

getStreamPrintPeriod()

double dynamicgraph::Entity::getStreamPrintPeriod ( )

inline

Get the period of the stream period.

getTimeSample()

double dynamicgraph::Entity::getTimeSample ( )

inline

Get the time sample.

hasSignal()

bool dynamicgraph::Entity::hasSignal

(

const std::string &

signame

)

const

logger() [1/2]

Logger& dynamicgraph::Entity::logger ( )

inline

logger() [2/2]

Logger const& dynamicgraph::Entity::logger ( ) const

inline

References dynamicgraph::MSG_TYPE_INFO.

sendMsg()

void dynamicgraph::Entity::sendMsg	(	const std::string &	msg,
		MsgType	t = MSG_TYPE_INFO,
		const std::string &	lineId = ""
	)

Send messages msg with level t.

Add string file and line to message.

setLoggerVerbosityLevel()

void dynamicgraph::Entity::setLoggerVerbosityLevel ( LoggerVerbosity  lv )

inline

Specify the verbosity level of the logger.

setStreamPrintPeriod()

bool dynamicgraph::Entity::setStreamPrintPeriod ( double  t )

inline

Set the period of the stream period.

setTimeSample()

bool dynamicgraph::Entity::setTimeSample ( double  t )

inline

Set the time sample.

signalDeregistration()

void dynamicgraph::Entity::signalDeregistration ( const std::string &  name )

protected

signalRegistration()

void dynamicgraph::Entity::signalRegistration ( const SignalArray< int > &  signals )

protected

test()

virtual SignalBase<int>* dynamicgraph::Entity::test ( )

inlinevirtual

test2()

virtual void dynamicgraph::Entity::test2 ( SignalBase< int > *  )

inlinevirtual

writeCompletionList()

virtual std::ostream& dynamicgraph::Entity::writeCompletionList ( std::ostream &  os ) const

virtual

writeGraph()

virtual std::ostream& dynamicgraph::Entity::writeGraph ( std::ostream &  os ) const

virtual

Member Data Documentation

commandMap

CommandMap_t dynamicgraph::Entity::commandMap

protected

logger_

Logger dynamicgraph::Entity::logger_

protected

name

std::string dynamicgraph::Entity::name

protected

signalMap

SignalMap dynamicgraph::Entity::signalMap

protected