Public Member Functions

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

This class keep tracks of all the objects in the stack of Tasks. More...

List of all members.

Public Types

Define types to simplify the writing

typedef std::map< std::string,
Entity * > 
Entities
 Sorted set of entities with unique key (name).

Public Member Functions

SignalBase< int > & getSignal (std::istringstream &sigpath)
 Get a reference to a signal.
void commandLine (const std::string &objectName, const std::string &functionName, std::istringstream &cmdArg, std::ostream &os)
 This method looks for the object named objectName, and ask to provide the function functionName with the arguments cmdArg. If the method of the object displays some information this will be done on os.
void writeGraph (const std::string &aFileName)
 This method write a graph description on the file named FileName.
void writeCompletionList (std::ostream &os)
Method related to the handling of entities.

void registerEntity (const std::string &entname, Entity *ent)
 Register an entity.
void deregisterEntity (const std::string &entname)
 Unregister an entity.
EntitygetEntity (const std::string &name)
 Get an entity.
void clearPlugin (const std::string &name)
 Disallocate an entity.

Fields of the class to manage the three entities.

Also the name is singular, those are true sets.



Entities entity
 Set of basic objects of the SoT.
 ~PoolStorage (void)
 Default destructor.

Detailed Description

This class keep tracks of all the objects in the stack of Tasks.

This class gives access to and remembers all the entities created during its life.

This class provides the necessary operations to register, unregister each instance of thoses classes. As tasks and features derived from Entities, they should be registered as such.

Note:
From the code it is not very clear why we should not unregister from the tasks and the features...

The role of this class is also to look for the object supporting a command, and to apply this command.

It also returns signal.


Member Typedef Documentation

typedef std::map< std::string,Entity* > dynamicgraph::PoolStorage::Entities

Sorted set of entities with unique key (name).


Constructor & Destructor Documentation

dynamicgraph::PoolStorage::~PoolStorage ( void   ) 

Default destructor.


Member Function Documentation

void dynamicgraph::PoolStorage::clearPlugin ( const std::string &  name  ) 

Disallocate an entity.

[in] entname: The name of the entity,
void dynamicgraph::PoolStorage::commandLine ( const std::string &  objectName,
const std::string &  functionName,
std::istringstream &  cmdArg,
std::ostream &  os 
)

This method looks for the object named objectName, and ask to provide the function functionName with the arguments cmdArg. If the method of the object displays some information this will be done on os.

The commands specific to the g_pool< > object are:

  • list : List all the entities registered in the g_pool.s

void dynamicgraph::PoolStorage::deregisterEntity ( const std::string &  entname  ) 

Unregister an entity.

[in] entname: The name of the entity,
Entity& dynamicgraph::PoolStorage::getEntity ( const std::string &  name  ) 

Get an entity.

[in] entname: The name of the entity,
Returns:
Pointer towards the entity.
SignalBase<int>& dynamicgraph::PoolStorage::getSignal ( std::istringstream &  sigpath  ) 

Get a reference to a signal.

void dynamicgraph::PoolStorage::registerEntity ( const std::string &  entname,
Entity ent 
)

Register an entity.

[in] entname: The name of the entity,
[in] ent: Pointer towards the entity.
void dynamicgraph::PoolStorage::writeCompletionList ( std::ostream &  os  ) 
void dynamicgraph::PoolStorage::writeGraph ( const std::string &  aFileName  ) 

This method write a graph description on the file named FileName.


Member Data Documentation

Set of basic objects of the SoT.





dynamicGraph library documentation