argos::CEPuckEntity Class Reference

#include <epuck_entity.h>

Inheritance diagram for argos::CEPuckEntity:
Collaboration diagram for argos::CEPuckEntity:

Public Member Functions

 ENABLE_VTABLE ()
 
 CEPuckEntity ()
 
 CEPuckEntity (const std::string &str_id, const std::string &str_controller_id, const CVector3 &c_position=CVector3(), const CQuaternion &c_orientation=CQuaternion(), Real f_rab_range=0.8f, size_t un_rab_data_size=2, const std::string &str_bat_model="")
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
virtual void Reset ()
 Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. More...
 
virtual void Destroy ()
 Destroys the entity, undoing whatever was done by Init() or by the standalone constructor. More...
 
virtual void UpdateComponents ()
 Calls the Update() method on all the components. More...
 
CControllableEntityGetControllableEntity ()
 
CEmbodiedEntityGetEmbodiedEntity ()
 
CGroundSensorEquippedEntityGetGroundSensorEquippedEntity ()
 
CLEDEquippedEntityGetLEDEquippedEntity ()
 
CLightSensorEquippedEntityGetLightSensorEquippedEntity ()
 
CProximitySensorEquippedEntityGetProximitySensorEquippedEntity ()
 
CRABEquippedEntityGetRABEquippedEntity ()
 
CWheeledEntityGetWheeledEntity ()
 
CBatteryEquippedEntityGetBatterySensorEquippedEntity ()
 
virtual std::string GetTypeDescription () const
 Returns a string label for this class. More...
 
- Public Member Functions inherited from argos::CComposableEntity
 ENABLE_VTABLE ()
 
 CComposableEntity (CComposableEntity *pc_parent)
 Class constructor. More...
 
 CComposableEntity (CComposableEntity *pc_parent, const std::string &str_id)
 Class constructor. More...
 
virtual ~CComposableEntity ()
 Class destructor. More...
 
virtual void Update ()
 Updates the status of this entity. More...
 
virtual void SetEnabled (bool b_enabled)
 Enables or disables an entity. More...
 
void AddComponent (CEntity &c_component)
 Adds a component to this composable entity. More...
 
CEntityRemoveComponent (const std::string &str_component)
 Removes a component from this composable entity. More...
 
CEntityGetComponent (const std::string &str_component)
 Returns the component with the passed string label. More...
 
template<class E >
E & GetComponent (const std::string &str_component)
 Returns the component with the passed string label. More...
 
bool HasComponent (const std::string &str_component)
 Returns true if this composable entity has a component with the given string label. More...
 
CEntity::TMultiMap::iterator FindComponent (const std::string &str_component)
 Searches for a component with the given string label. More...
 
CEntity::TMultiMapGetComponentMap ()
 Returns the map of all the components. More...
 
CEntity::TVectorGetComponentVector ()
 Returns the vector of all the components. More...
 
- Public Member Functions inherited from argos::CEntity
 ENABLE_VTABLE ()
 
 CEntity (CComposableEntity *pc_parent)
 Class constructor. More...
 
 CEntity (CComposableEntity *pc_parent, const std::string &str_id)
 Class constructor. More...
 
virtual ~CEntity ()
 Class destructor. More...
 
const std::string & GetId () const
 Returns the id of this entity. More...
 
std::string GetContext () const
 Returns the context of this entity. More...
 
bool HasParent () const
 Returns true if this entity has a parent. More...
 
CEntityGetRootEntity ()
 Returns the root entity containing this entity. More...
 
const CEntityGetRootEntity () const
 Returns the root entity containing this entity. More...
 
CComposableEntityGetParent ()
 Returns this entity's parent. More...
 
const CComposableEntityGetParent () const
 Returns this entity's parent. More...
 
void SetParent (CComposableEntity &c_parent)
 Sets this entity's parent. More...
 
ssize_t GetIndex () const
 Returns the entity index. More...
 
void SetIndex (ssize_t n_idx)
 Sets the entity index. More...
 
bool IsEnabled () const
 Returns true if the entity is enabled. More...
 
void Enable ()
 Enables the entity. More...
 
void Disable ()
 Disables the entity. More...
 
TConfigurationNodeGetConfigurationNode ()
 Returns a pointer to the configuration node that was used to create this entity. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::EnableVTableFor< CEntity >
size_t GetTagHelper (const DERIVED *) const
 

Additional Inherited Members

- Public Types inherited from argos::CEntity
typedef std::vector< CEntity * > TVector
 A vector of entities. More...
 
typedef unordered_map< std::string, CEntity * > TMap
 A map of entities. More...
 
typedef std::multimap< std::string, CEntity * > TMultiMap
 A multi-map of entities. More...
 

Detailed Description

Definition at line 27 of file epuck_entity.h.

Constructor & Destructor Documentation

argos::CEPuckEntity::CEPuckEntity ( )

Definition at line 45 of file epuck_entity.cpp.

argos::CEPuckEntity::CEPuckEntity ( const std::string &  str_id,
const std::string &  str_controller_id,
const CVector3 c_position = CVector3(),
const CQuaternion c_orientation = CQuaternion(),
Real  f_rab_range = 0.8f,
size_t  un_rab_data_size = 2,
const std::string &  str_bat_model = "" 
)

Definition at line 61 of file epuck_entity.cpp.

Member Function Documentation

void argos::CEPuckEntity::Destroy ( )
virtual

Destroys the entity, undoing whatever was done by Init() or by the standalone constructor.

The default implementation of this method does nothing.

Reimplemented from argos::CEntity.

Definition at line 274 of file epuck_entity.cpp.

argos::CEPuckEntity::ENABLE_VTABLE ( )
CBatteryEquippedEntity& argos::CEPuckEntity::GetBatterySensorEquippedEntity ( )
inline

Definition at line 83 of file epuck_entity.h.

CControllableEntity& argos::CEPuckEntity::GetControllableEntity ( )
inline

Definition at line 51 of file epuck_entity.h.

CEmbodiedEntity& argos::CEPuckEntity::GetEmbodiedEntity ( )
inline

Definition at line 55 of file epuck_entity.h.

CGroundSensorEquippedEntity& argos::CEPuckEntity::GetGroundSensorEquippedEntity ( )
inline

Definition at line 59 of file epuck_entity.h.

CLEDEquippedEntity& argos::CEPuckEntity::GetLEDEquippedEntity ( )
inline

Definition at line 63 of file epuck_entity.h.

CLightSensorEquippedEntity& argos::CEPuckEntity::GetLightSensorEquippedEntity ( )
inline

Definition at line 67 of file epuck_entity.h.

CProximitySensorEquippedEntity& argos::CEPuckEntity::GetProximitySensorEquippedEntity ( )
inline

Definition at line 71 of file epuck_entity.h.

CRABEquippedEntity& argos::CEPuckEntity::GetRABEquippedEntity ( )
inline

Definition at line 75 of file epuck_entity.h.

virtual std::string argos::CEPuckEntity::GetTypeDescription ( ) const
inlinevirtual

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CComposableEntity.

Definition at line 87 of file epuck_entity.h.

CWheeledEntity& argos::CEPuckEntity::GetWheeledEntity ( )
inline

Definition at line 79 of file epuck_entity.h.

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

Initializes the state of the entity from the XML configuration tree.

If the id of the entity has not been set yet, this method sets an id for the entity. If the entity has no parent, this method parses the passed XML tree and looks for the id attribute, setting its value as id. If, instead, this entity has a parent, the id is set as GetParent().GetId() + "." + GetTypeDescription().

Exceptions
CARGoSExceptionif a parse error occurred

Reimplemented from argos::CEntity.

Definition at line 165 of file epuck_entity.cpp.

void argos::CEPuckEntity::Reset ( )
virtual

Resets the state of the entity to whatever it was after Init() or the standalone constructor was called.

Internally calls Reset() for all the component entities.

Reimplemented from argos::CComposableEntity.

Definition at line 264 of file epuck_entity.cpp.

void argos::CEPuckEntity::UpdateComponents ( )
virtual

Calls the Update() method on all the components.

See also
Update()

Reimplemented from argos::CComposableEntity.

Definition at line 283 of file epuck_entity.cpp.