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 void | commandLine (const std::string &cmdLine, std::istringstream &cmdArgs, std::ostream &os) |
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. A command-line interface provided by the entity can be used by a sot shell to call methods from entities and display the result of their execution. Classes that derive from Entity can customize the command-line by overriding commandLine ().
typedef std::map<const std::string, command::Command*> dynamicgraph::Entity::CommandMap_t |
typedef std::map< std::string,SignalBase<int>* > dynamicgraph::Entity::SignalMap |
|
explicit |
|
virtual |
|
protected |
|
virtual |
Reimplemented in dynamicgraph::Tracer, and dynamicgraph::TracerRealTime.
|
virtual |
Reimplemented in dynamicgraph::Tracer, and dynamicgraph::TracerRealTime.
std::ostream& dynamicgraph::Entity::displaySignalList | ( | std::ostream & | os | ) | const |
|
protected |
|
protected |
|
pure virtual |
const std::string& dynamicgraph::Entity::getCommandList | ( | ) | const |
|
virtual |
|
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 |
|
protected |
|
protected |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
protected |
|
protected |
|
protected |