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

#include <medium.h>

+ Inheritance diagram for argos::CMedium:

List of all members.

Public Types

typedef std::vector< CMedium * > TVector
typedef std::map< std::string,
CMedium * > 
TMap

Public Member Functions

 CMedium ()
virtual ~CMedium ()
virtual void Init (TConfigurationNode &t_tree)
 Initialized the medium.
virtual void Reset ()
 Resets the resource.
virtual void Destroy ()
 Undoes whatever was done by Init().
virtual void PostSpaceInit ()
 Executes extra initialization activities after the space has been initialized.
virtual void Update ()=0
 Updates the state of this medium.
const std::string & GetId () const
 Returns the id of this medium.
void SetId (const std::string &str_id)
 Sets the id of this medium.

Detailed Description

Definition at line 21 of file medium.h.


Member Typedef Documentation

typedef std::map<std::string, CMedium*> argos::CMedium::TMap

Definition at line 26 of file medium.h.

typedef std::vector<CMedium*> argos::CMedium::TVector

Definition at line 25 of file medium.h.


Constructor & Destructor Documentation

Definition at line 30 of file medium.h.

virtual argos::CMedium::~CMedium ( ) [inline, virtual]

Definition at line 31 of file medium.h.


Member Function Documentation

virtual void argos::CMedium::Destroy ( ) [inline, virtual]

Undoes whatever was done by Init().

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CRABMedium, and argos::CLEDMedium.

Definition at line 49 of file medium.h.

const std::string& argos::CMedium::GetId ( ) const [inline]

Returns the id of this medium.

Returns:
The id of this medium.

Definition at line 75 of file medium.h.

void argos::CMedium::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()

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CRABMedium, and argos::CLEDMedium.

Definition at line 15 of file medium.cpp.

virtual void argos::CMedium::PostSpaceInit ( ) [inline, 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 in argos::CRABMedium, and argos::CLEDMedium.

Definition at line 64 of file medium.h.

virtual void argos::CMedium::Reset ( ) [inline, virtual]

Resets the resource.

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CRABMedium, and argos::CLEDMedium.

Definition at line 48 of file medium.h.

void argos::CMedium::SetId ( const std::string &  str_id) [inline]

Sets the id of this medium.

Parameters:
str_idThe id of this medium.

Definition at line 83 of file medium.h.

virtual void argos::CMedium::Update ( ) [pure virtual]

Updates the state of this medium.

Implemented in argos::CRABMedium, and argos::CLEDMedium.


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