Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes

dynamicgraph::Entity Class Reference
[Core classes and objects]

This class represents an entity, i.e. a generic computational unit that provides input and output signals. More...

List of all members.

Public Member Functions

 Entity (const std::string &name)
virtual ~Entity (void)
const std::string & getName (void) const
virtual const std::string & getClassName (void) 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 (void)
virtual void test2 (SignalBase< int > *ptr)
virtual const std::string & getCommandList (void) const

Static Public Attributes

static const std::string CLASS_NAME

Protected Types

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

Protected Member Functions

void entityRegistration (void)
void entityDeregistration (void)
void signalRegistration (const SignalArray< int > &signals)
void signalDeregistration (const std::string &name)

Protected Attributes

std::string name
SignalMap signalMap

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 g_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().


Member Typedef Documentation

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

Constructor & Destructor Documentation

dynamicgraph::Entity::Entity ( const std::string &  name  ) 
virtual dynamicgraph::Entity::~Entity ( void   )  [virtual]

Member Function Documentation

virtual void dynamicgraph::Entity::commandLine ( const std::string &  cmdLine,
std::istringstream &  cmdArgs,
std::ostream &  os 
) [virtual]
virtual void dynamicgraph::Entity::display ( std::ostream &  os  )  const [virtual]
std::ostream& dynamicgraph::Entity::displaySignalList ( std::ostream &  os  )  const
void dynamicgraph::Entity::entityDeregistration ( void   )  [protected]
void dynamicgraph::Entity::entityRegistration ( void   )  [protected]
virtual const std::string& dynamicgraph::Entity::getClassName ( void   )  const [inline, virtual]
virtual const std::string& dynamicgraph::Entity::getCommandList ( void   )  const [virtual]
const std::string& dynamicgraph::Entity::getName ( void   )  const [inline]
const SignalBase<int>& dynamicgraph::Entity::getSignal ( const std::string &  signalName  )  const
SignalBase<int>& dynamicgraph::Entity::getSignal ( const std::string &  signalName  ) 
void dynamicgraph::Entity::signalDeregistration ( const std::string &  name  )  [protected]
void dynamicgraph::Entity::signalRegistration ( const SignalArray< int > &  signals  )  [protected]
virtual SignalBase<int>* dynamicgraph::Entity::test ( void   )  [inline, virtual]
virtual void dynamicgraph::Entity::test2 ( SignalBase< int > *  ptr  )  [inline, virtual]
virtual std::ostream& dynamicgraph::Entity::writeCompletionList ( std::ostream &  os  )  const [virtual]
virtual std::ostream& dynamicgraph::Entity::writeGraph ( std::ostream &  os  )  const [virtual]

Member Data Documentation

const std::string dynamicgraph::Entity::CLASS_NAME [static]
std::string dynamicgraph::Entity::name [protected]




dynamicGraph library documentation