argos::CLEDMedium Class Reference

#include <led_medium.h>

Inheritance diagram for argos::CLEDMedium:
Collaboration diagram for argos::CLEDMedium:

Public Member Functions

 CLEDMedium ()
 Class constructor. More...
 
virtual ~CLEDMedium ()
 Class destructor. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initialized the medium. More...
 
virtual void PostSpaceInit ()
 Executes extra initialization activities after the space has been initialized. More...
 
virtual void Reset ()
 Resets the resource. More...
 
virtual void Destroy ()
 Undoes whatever was done by Init(). More...
 
virtual void Update ()
 Updates the state of this medium. More...
 
void AddEntity (CLEDEntity &c_entity)
 Adds the specified entity to the list of managed entities. More...
 
void RemoveEntity (CLEDEntity &c_entity)
 Removes the specified entity from the list of managed entities. More...
 
CPositionalIndex< CLEDEntity > & GetIndex ()
 Returns the LED positional index. More...
 
- Public Member Functions inherited from argos::CMedium
 CMedium ()
 
virtual ~CMedium ()
 
const std::string & GetId () const
 Returns the id of this medium. More...
 
void SetId (const std::string &str_id)
 Sets the id of this medium. More...
 
CSpaceGetSpace ()
 Returns a reference to the ARGoS space. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Additional Inherited Members

- Public Types inherited from argos::CMedium
typedef std::vector< CMedium * > TVector
 
typedef std::map< std::string, CMedium * > TMap
 

Detailed Description

Definition at line 15 of file led_medium.h.

Constructor & Destructor Documentation

argos::CLEDMedium::CLEDMedium ( )

Class constructor.

Definition at line 13 of file led_medium.cpp.

argos::CLEDMedium::~CLEDMedium ( )
virtual

Class destructor.

Definition at line 19 of file led_medium.cpp.

Member Function Documentation

void argos::CLEDMedium::AddEntity ( CLEDEntity c_entity)

Adds the specified entity to the list of managed entities.

Parameters
c_entityThe entity to add.

Definition at line 100 of file led_medium.cpp.

void argos::CLEDMedium::Destroy ( )
virtual

Undoes whatever was done by Init().

Reimplemented from argos::CMedium.

Definition at line 83 of file led_medium.cpp.

CPositionalIndex<CLEDEntity>& argos::CLEDMedium::GetIndex ( )
inline

Returns the LED positional index.

Returns
The LED positional index.

Definition at line 51 of file led_medium.h.

void argos::CLEDMedium::Init ( TConfigurationNode t_tree)
virtual

Initialized the medium.

By default, this method parses the medium id. The order in which initialization takes place is:

Parameters
t_treethe base of the XML configuration tree to parse
Exceptions
CARGoSExceptionif an error occurs
See also
PostSpaceInitInit()
CSpace::Init()

Reimplemented from argos::CMedium.

Definition at line 25 of file led_medium.cpp.

void argos::CLEDMedium::PostSpaceInit ( )
virtual

Executes extra initialization activities after the space has been initialized.

By default, this method does nothing. The order in which initialization takes place is:

Exceptions
CARGoSExceptionif an error occurs
See also
Init()
CSpace::Init()

Reimplemented from argos::CMedium.

Definition at line 69 of file led_medium.cpp.

void argos::CLEDMedium::RemoveEntity ( CLEDEntity c_entity)

Removes the specified entity from the list of managed entities.

Parameters
c_entityThe entity to remove.

Definition at line 107 of file led_medium.cpp.

void argos::CLEDMedium::Reset ( )
virtual

Resets the resource.

Reimplemented from argos::CMedium.

Definition at line 76 of file led_medium.cpp.

void argos::CLEDMedium::Update ( )
virtual

Updates the state of this medium.

Implements argos::CMedium.

Definition at line 93 of file led_medium.cpp.