ARGoS
3
A parallel, multi-engine simulator for swarm robotics
|
#include <epuck_entity.h>
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) | |
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... | |
CControllableEntity & | GetControllableEntity () |
CEmbodiedEntity & | GetEmbodiedEntity () |
CGroundSensorEquippedEntity & | GetGroundSensorEquippedEntity () |
CLEDEquippedEntity & | GetLEDEquippedEntity () |
CLightSensorEquippedEntity & | GetLightSensorEquippedEntity () |
CProximitySensorEquippedEntity & | GetProximitySensorEquippedEntity () |
CRABEquippedEntity & | GetRABEquippedEntity () |
CWheeledEntity & | GetWheeledEntity () |
virtual std::string | GetTypeDescription () const |
Returns a string label for this class. More... | |
![]() | |
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... | |
CEntity & | RemoveComponent (const std::string &str_component) |
Removes a component from this composable entity. More... | |
CEntity & | GetComponent (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::TMultiMap & | GetComponentMap () |
Returns the map of all the components. More... | |
CEntity::TVector & | GetComponentVector () |
Returns the vector of all the components. More... | |
![]() | |
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... | |
CEntity & | GetRootEntity () |
Returns the root entity containing this entity. More... | |
const CEntity & | GetRootEntity () const |
Returns the root entity containing this entity. More... | |
CComposableEntity & | GetParent () |
Returns this entity's parent. More... | |
const CComposableEntity & | GetParent () const |
Returns this entity's parent. More... | |
void | SetParent (CComposableEntity &c_parent) |
Sets this entity's parent. More... | |
bool | IsEnabled () const |
Returns true if the entity is enabled. More... | |
void | Enable () |
Enables the entity. More... | |
void | Disable () |
Disables the entity. More... | |
![]() | |
virtual | ~CBaseConfigurableResource () |
Class destructor. More... | |
![]() | |
size_t | GetTagHelper (const DERIVED *) const |
Additional Inherited Members | |
![]() | |
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... | |
Definition at line 26 of file epuck_entity.h.
argos::CEPuckEntity::CEPuckEntity | ( | ) |
Definition at line 44 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 |
||
) |
Definition at line 59 of file epuck_entity.cpp.
|
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 262 of file epuck_entity.cpp.
argos::CEPuckEntity::ENABLE_VTABLE | ( | ) |
|
inline |
Definition at line 49 of file epuck_entity.h.
|
inline |
Definition at line 53 of file epuck_entity.h.
|
inline |
Definition at line 57 of file epuck_entity.h.
|
inline |
Definition at line 61 of file epuck_entity.h.
|
inline |
Definition at line 65 of file epuck_entity.h.
|
inline |
Definition at line 69 of file epuck_entity.h.
|
inline |
Definition at line 73 of file epuck_entity.h.
|
inlinevirtual |
Returns a string label for this class.
Reimplemented from argos::CComposableEntity.
Definition at line 81 of file epuck_entity.h.
|
inline |
Definition at line 77 of file epuck_entity.h.
|
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()
.
CARGoSException | if a parse error occurred |
Reimplemented from argos::CEntity.
Definition at line 158 of file epuck_entity.cpp.
|
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 252 of file epuck_entity.cpp.
|
virtual |
Calls the Update() method on all the components.
Reimplemented from argos::CComposableEntity.
Definition at line 271 of file epuck_entity.cpp.