This class represents an entity, i.e. More...
#include <dynamic-graph/entity.h>
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 =0 |
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 |
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 |
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.
typedef std::map<const std::string, command::Command*> dynamicgraph::Entity::CommandMap_t |
typedef std::map< std::string,SignalBase<int>* > dynamicgraph::Entity::SignalMap |
dynamicgraph::Entity::Entity | ( | const std::string & | name | ) | [explicit] |
virtual dynamicgraph::Entity::~Entity | ( | ) | [virtual] |
void dynamicgraph::Entity::addCommand | ( | const std::string & | name, |
command::Command * | command | ||
) | [protected] |
virtual void dynamicgraph::Entity::display | ( | std::ostream & | os | ) | const [virtual] |
Reimplemented in dynamicgraph::Tracer, and dynamicgraph::TracerRealTime.
std::ostream& dynamicgraph::Entity::displaySignalList | ( | std::ostream & | os | ) | const |
void dynamicgraph::Entity::entityDeregistration | ( | ) | [protected] |
void dynamicgraph::Entity::entityRegistration | ( | ) | [protected] |
virtual const std::string& dynamicgraph::Entity::getClassName | ( | ) | const [pure virtual] |
const std::string& dynamicgraph::Entity::getCommandList | ( | ) | const |
virtual std::string dynamicgraph::Entity::getDocString | ( | ) | const [virtual] |
const std::string& dynamicgraph::Entity::getName | ( | ) | const [inline] |
command::Command* dynamicgraph::Entity::getNewStyleCommand | ( | const std::string & | cmdName | ) |
CommandMap_t dynamicgraph::Entity::getNewStyleCommandMap | ( | ) |
SignalBase<int>& dynamicgraph::Entity::getSignal | ( | const std::string & | signalName | ) |
const SignalBase<int>& dynamicgraph::Entity::getSignal | ( | const std::string & | signalName | ) | const |
SignalMap dynamicgraph::Entity::getSignalMap | ( | ) | const |
bool dynamicgraph::Entity::hasSignal | ( | const std::string & | signame | ) | const |
void dynamicgraph::Entity::signalDeregistration | ( | const std::string & | name | ) | [protected] |
void dynamicgraph::Entity::signalRegistration | ( | const SignalArray< int > & | signals | ) | [protected] |
virtual SignalBase<int>* dynamicgraph::Entity::test | ( | ) | [inline, virtual] |
virtual void dynamicgraph::Entity::test2 | ( | SignalBase< int > * | ) | [inline, virtual] |
virtual std::ostream& dynamicgraph::Entity::writeCompletionList | ( | std::ostream & | os | ) | const [virtual] |
virtual std::ostream& dynamicgraph::Entity::writeGraph | ( | std::ostream & | os | ) | const [virtual] |
CommandMap_t dynamicgraph::Entity::commandMap [protected] |
std::string dynamicgraph::Entity::name [protected] |
SignalMap dynamicgraph::Entity::signalMap [protected] |