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

#include <rab_medium.h>

+ Inheritance diagram for argos::CRABMedium:

List of all members.

Public Member Functions

 CRABMedium ()
 Class constructor.
virtual ~CRABMedium ()
 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 (CRABEquippedEntity &c_entity)
 Adds the specified entity to the list of managed entities.
void RemoveEntity (CRABEquippedEntity &c_entity)
 Removes the specified entity from the list of managed entities.
const CSet< CRABEquippedEntity * > & GetRABsCommunicatingWith (CRABEquippedEntity &c_entity) const
 Returns an immutable vector of RAB entities that can communicated with the given entity.

Detailed Description

Definition at line 16 of file rab_medium.h.


Constructor & Destructor Documentation

Class constructor.

Definition at line 14 of file rab_medium.cpp.

Class destructor.

Definition at line 20 of file rab_medium.cpp.


Member Function Documentation

Adds the specified entity to the list of managed entities.

Parameters:
c_entityThe entity to add.

Definition at line 198 of file rab_medium.cpp.

void argos::CRABMedium::Destroy ( ) [virtual]

Undoes whatever was done by Init().

Reimplemented from argos::CMedium.

Definition at line 91 of file rab_medium.cpp.

Returns an immutable vector of RAB entities that can communicated with the given entity.

Parameters:
c_entityThe wanted entity.
Returns:
An immutable vector of RAB entities that can communicated with the given entity.
Exceptions:
CARGoSExceptionIf the passed entity is not managed by this medium.

Definition at line 222 of file rab_medium.cpp.

void argos::CRABMedium::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 26 of file rab_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 70 of file rab_medium.cpp.

Removes the specified entity from the list of managed entities.

Parameters:
c_entityThe entity to remove.

Definition at line 208 of file rab_medium.cpp.

void argos::CRABMedium::Reset ( ) [virtual]

Resets the resource.

Reimplemented from argos::CMedium.

Definition at line 77 of file rab_medium.cpp.

void argos::CRABMedium::Update ( ) [virtual]

Updates the state of this medium.

Implements argos::CMedium.

Definition at line 107 of file rab_medium.cpp.


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