argos::CProximitySensorEquippedEntity Class Reference

#include <proximity_sensor_equipped_entity.h>

Inheritance diagram for argos::CProximitySensorEquippedEntity:
Collaboration diagram for argos::CProximitySensorEquippedEntity:

Classes

struct  SSensor
 

Public Member Functions

 ENABLE_VTABLE ()
 
 CProximitySensorEquippedEntity (CComposableEntity *pc_parent)
 
 CProximitySensorEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id)
 
virtual ~CProximitySensorEquippedEntity ()
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
virtual std::string GetTypeDescription () const
 Returns a string label for this class. More...
 
virtual void Enable ()
 
virtual void Disable ()
 
size_t GetNumSensors () const
 
SSensorGetSensor (size_t un_idx)
 
SSensor::TListGetSensors ()
 
void AddSensor (const CVector3 &c_offset, const CVector3 &c_direction, Real f_range, SAnchor &s_anchor)
 
void AddSensorRing (const CVector3 &c_center, Real f_radius, const CRadians &c_start_angle, Real f_range, UInt32 un_num_sensors, SAnchor &s_anchor)
 
void AddSensorFan (const CVector3 &c_center, Real f_radius, const CRadians &c_start_angle, const CRadians &c_end_angle, Real f_range, UInt32 un_num_sensors, SAnchor &s_anchor)
 
- 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...
 
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...
 
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...
 
virtual void Update ()
 Updates the state of this entity. 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...
 
virtual void SetEnabled (bool b_enabled)
 Enables or disables an 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
 

Protected Attributes

SSensor::TList m_tSensors
 The list of sensors. More...
 

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 21 of file proximity_sensor_equipped_entity.h.

Constructor & Destructor Documentation

argos::CProximitySensorEquippedEntity::CProximitySensorEquippedEntity ( CComposableEntity pc_parent)

Definition at line 30 of file proximity_sensor_equipped_entity.cpp.

argos::CProximitySensorEquippedEntity::CProximitySensorEquippedEntity ( CComposableEntity pc_parent,
const std::string &  str_id 
)

Definition at line 38 of file proximity_sensor_equipped_entity.cpp.

argos::CProximitySensorEquippedEntity::~CProximitySensorEquippedEntity ( )
virtual

Definition at line 47 of file proximity_sensor_equipped_entity.cpp.

Member Function Documentation

void argos::CProximitySensorEquippedEntity::AddSensor ( const CVector3 c_offset,
const CVector3 c_direction,
Real  f_range,
SAnchor s_anchor 
)

Definition at line 144 of file proximity_sensor_equipped_entity.cpp.

void argos::CProximitySensorEquippedEntity::AddSensorFan ( const CVector3 c_center,
Real  f_radius,
const CRadians c_start_angle,
const CRadians c_end_angle,
Real  f_range,
UInt32  un_num_sensors,
SAnchor s_anchor 
)

Definition at line 178 of file proximity_sensor_equipped_entity.cpp.

void argos::CProximitySensorEquippedEntity::AddSensorRing ( const CVector3 c_center,
Real  f_radius,
const CRadians c_start_angle,
Real  f_range,
UInt32  un_num_sensors,
SAnchor s_anchor 
)

Definition at line 154 of file proximity_sensor_equipped_entity.cpp.

void argos::CProximitySensorEquippedEntity::Disable ( )
virtual

Definition at line 134 of file proximity_sensor_equipped_entity.cpp.

void argos::CProximitySensorEquippedEntity::Enable ( )
virtual

Definition at line 124 of file proximity_sensor_equipped_entity.cpp.

argos::CProximitySensorEquippedEntity::ENABLE_VTABLE ( )
size_t argos::CProximitySensorEquippedEntity::GetNumSensors ( ) const
inline

Definition at line 59 of file proximity_sensor_equipped_entity.h.

SSensor& argos::CProximitySensorEquippedEntity::GetSensor ( size_t  un_idx)
inline

Definition at line 63 of file proximity_sensor_equipped_entity.h.

SSensor::TList& argos::CProximitySensorEquippedEntity::GetSensors ( )
inline

Definition at line 67 of file proximity_sensor_equipped_entity.h.

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

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 51 of file proximity_sensor_equipped_entity.h.

void argos::CProximitySensorEquippedEntity::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 57 of file proximity_sensor_equipped_entity.cpp.

Member Data Documentation

SSensor::TList argos::CProximitySensorEquippedEntity::m_tSensors
protected

The list of sensors.

Definition at line 94 of file proximity_sensor_equipped_entity.h.