ARGoS  3
A parallel, multi-engine simulator for swarm robotics
argos::CLEDMedium Class Reference

#include <led_medium.h>

+ Inheritance diagram for argos::CLEDMedium:

List of all members.

Public Member Functions

 CLEDMedium ()
 Class constructor.
virtual ~CLEDMedium ()
 Class destructor.
virtual void Init (TConfigurationNode &t_tree)
 Initialized the medium.
virtual void PostSpaceInit ()
 Executes extra initialization activities after the space has been initialized.
virtual void Reset ()
 Resets the resource.
virtual void Destroy ()
 Undoes whatever was done by Init().
virtual void Update ()
 Updates the state of this medium.
void AddEntity (CLEDEntity &c_entity)
 Adds the specified entity to the list of managed entities.
void RemoveEntity (CLEDEntity &c_entity)
 Removes the specified entity from the list of managed entities.
CPositionalIndex< CLEDEntity > & GetIndex ()
 Returns the LED positional index.

Detailed Description

Definition at line 15 of file led_medium.h.


Constructor & Destructor Documentation

Class constructor.

Definition at line 13 of file led_medium.cpp.

Class destructor.

Definition at line 19 of file led_medium.cpp.


Member Function Documentation

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.

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.

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.

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.


The documentation for this class was generated from the following files: