argos::CTagMedium Class Reference

#include <tag_medium.h>

Inheritance diagram for argos::CTagMedium:
Collaboration diagram for argos::CTagMedium:

Public Member Functions

 CTagMedium ()
 Class constructor. More...
 
virtual ~CTagMedium ()
 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 (CTagEntity &c_entity)
 Adds the specified entity to the list of managed entities. More...
 
void RemoveEntity (CTagEntity &c_entity)
 Removes the specified entity from the list of managed entities. More...
 
CPositionalIndex< CTagEntity > & GetIndex ()
 Returns the tag 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 21 of file tag_medium.h.

Constructor & Destructor Documentation

argos::CTagMedium::CTagMedium ( )
inline

Class constructor.

Definition at line 28 of file tag_medium.h.

virtual argos::CTagMedium::~CTagMedium ( )
inlinevirtual

Class destructor.

Definition at line 35 of file tag_medium.h.

Member Function Documentation

void argos::CTagMedium::AddEntity ( CTagEntity c_entity)

Adds the specified entity to the list of managed entities.

Parameters
c_entityThe entity to add.

Definition at line 94 of file tag_medium.cpp.

void argos::CTagMedium::Destroy ( )
virtual

Undoes whatever was done by Init().

Reimplemented from argos::CMedium.

Definition at line 77 of file tag_medium.cpp.

CPositionalIndex<CTagEntity>& argos::CTagMedium::GetIndex ( )
inline

Returns the tag positional index.

Returns
The tag positional index.

Definition at line 59 of file tag_medium.h.

void argos::CTagMedium::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 19 of file tag_medium.cpp.

void argos::CTagMedium::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 63 of file tag_medium.cpp.

void argos::CTagMedium::RemoveEntity ( CTagEntity c_entity)

Removes the specified entity from the list of managed entities.

Parameters
c_entityThe entity to remove.

Definition at line 101 of file tag_medium.cpp.

void argos::CTagMedium::Reset ( )
virtual

Resets the resource.

Reimplemented from argos::CMedium.

Definition at line 70 of file tag_medium.cpp.

void argos::CTagMedium::Update ( )
virtual

Updates the state of this medium.

Implements argos::CMedium.

Definition at line 87 of file tag_medium.cpp.