argos::CDirectionalLEDEntity Class Reference

#include <directional_led_entity.h>

Inheritance diagram for argos::CDirectionalLEDEntity:
Collaboration diagram for argos::CDirectionalLEDEntity:

Public Types

typedef std::vector< CDirectionalLEDEntity * > TList
 
typedef CSet< CDirectionalLEDEntity * > TSet
 
- 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...
 

Public Member Functions

 ENABLE_VTABLE ()
 
 CDirectionalLEDEntity (CComposableEntity *pc_parent)
 
 CDirectionalLEDEntity (CComposableEntity *pc_parent, const std::string &str_id, const CVector3 &c_position, const CQuaternion &c_orientation, const CRadians &c_observable_angle, const CColor &c_color)
 
virtual ~CDirectionalLEDEntity ()
 
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 SetEnabled (bool b_enabled)
 Enables or disables an entity. More...
 
const CColorGetColor () const
 Returns the current color of the LED. More...
 
const CRadiansGetObservableAngle () const
 Returns the observable angle of the LED. More...
 
const CColorGetInitColor () const
 Returns the color with which the LED was initialized. More...
 
void SetColor (const CColor &c_color)
 Sets the current color of the LED. More...
 
void SetInitColor (const CColor &c_color)
 Sets the initialization color for this LED. More...
 
virtual std::string GetTypeDescription () const
 Returns a string label for this class. More...
 
bool HasMedium () const
 Returns true if this directional LED is associated to a medium. More...
 
CDirectionalLEDMediumGetMedium () const
 Returns the medium associated to this directional LED. More...
 
void SetMedium (CDirectionalLEDMedium &c_medium)
 Sets the medium associated to this entity. More...
 
- Public Member Functions inherited from argos::CPositionalEntity
 ENABLE_VTABLE ()
 
 CPositionalEntity (CComposableEntity *pc_parent)
 
 CPositionalEntity (CComposableEntity *pc_parent, const std::string &str_id, const CVector3 &c_position=CVector3(), const CQuaternion &c_orientation=CQuaternion())
 
const CVector3GetPosition () const
 
const CVector3GetInitPosition () const
 
void SetPosition (const CVector3 &c_position)
 
void SetInitPosition (const CVector3 &c_position)
 
const CQuaternionGetOrientation () const
 
const CQuaternionGetInitOrientation () const
 
void SetOrientation (const CQuaternion c_orientation)
 
void SetInitOrientation (const CQuaternion c_orientation)
 
virtual void MoveTo (const CVector3 &c_position, const CQuaternion &c_orientation)
 
- 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...
 
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...
 
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

CRadians m_cObservableAngle
 
CColor m_cColor
 
CColor m_cInitColor
 
CDirectionalLEDMediumm_pcMedium
 

Detailed Description

Definition at line 24 of file directional_led_entity.h.

Member Typedef Documentation

Definition at line 30 of file directional_led_entity.h.

Constructor & Destructor Documentation

argos::CDirectionalLEDEntity::CDirectionalLEDEntity ( CComposableEntity pc_parent)

Definition at line 17 of file directional_led_entity.cpp.

argos::CDirectionalLEDEntity::CDirectionalLEDEntity ( CComposableEntity pc_parent,
const std::string &  str_id,
const CVector3 c_position,
const CQuaternion c_orientation,
const CRadians c_observable_angle,
const CColor c_color 
)

Definition at line 29 of file directional_led_entity.cpp.

virtual argos::CDirectionalLEDEntity::~CDirectionalLEDEntity ( )
inlinevirtual

Definition at line 44 of file directional_led_entity.h.

Member Function Documentation

void argos::CDirectionalLEDEntity::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 71 of file directional_led_entity.cpp.

argos::CDirectionalLEDEntity::ENABLE_VTABLE ( )
const CColor& argos::CDirectionalLEDEntity::GetColor ( ) const
inline

Returns the current color of the LED.

Returns
the current color of the LED.
See also
GetInitColor()
SetColor()

Definition at line 60 of file directional_led_entity.h.

const CColor& argos::CDirectionalLEDEntity::GetInitColor ( ) const
inline

Returns the color with which the LED was initialized.

When the simulation is reset, the LED color is set to this value.

Returns
the color with which the LED was initialized.
See also
GetColor()
SetInitColor()

Definition at line 79 of file directional_led_entity.h.

CDirectionalLEDMedium & argos::CDirectionalLEDEntity::GetMedium ( ) const

Returns the medium associated to this directional LED.

Returns
The medium associated to this directional LED.
See also
CDirectionalLEDMedium

Definition at line 103 of file directional_led_entity.cpp.

const CRadians& argos::CDirectionalLEDEntity::GetObservableAngle ( ) const
inline

Returns the observable angle of the LED.

Returns
the observable angle of the LED.

Definition at line 68 of file directional_led_entity.h.

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

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CPositionalEntity.

Definition at line 101 of file directional_led_entity.h.

bool argos::CDirectionalLEDEntity::HasMedium ( ) const
inline

Returns true if this directional LED is associated to a medium.

Returns
true if this directional LED is associated to a medium.
See also
CDirectionalLEDMedium

Definition at line 110 of file directional_led_entity.h.

void argos::CDirectionalLEDEntity::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::CPositionalEntity.

Definition at line 46 of file directional_led_entity.cpp.

void argos::CDirectionalLEDEntity::Reset ( )
virtual

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

The default implementation of this method does nothing.

Reimplemented from argos::CPositionalEntity.

Definition at line 64 of file directional_led_entity.cpp.

void argos::CDirectionalLEDEntity::SetColor ( const CColor c_color)

Sets the current color of the LED.

Parameters
c_colorthe wanted color.
See also
GetColor()

Definition at line 96 of file directional_led_entity.cpp.

void argos::CDirectionalLEDEntity::SetEnabled ( bool  b_enabled)
virtual

Enables or disables an entity.

Parameters
b_enabledtrue if the entity is enabled, false otherwise
See also
m_bEnabled
m_bCanBeEnabledIfDisabled

Reimplemented from argos::CEntity.

Definition at line 78 of file directional_led_entity.cpp.

void argos::CDirectionalLEDEntity::SetInitColor ( const CColor c_color)
inline

Sets the initialization color for this LED.

When the simulation is reset, the LED color is set to this value.

Parameters
c_colorthe initialization color for this LED.
See also
GetInitColor()
SetColor()

Definition at line 97 of file directional_led_entity.h.

void argos::CDirectionalLEDEntity::SetMedium ( CDirectionalLEDMedium c_medium)

Sets the medium associated to this entity.

Parameters
c_mediumThe medium to associate to this entity.
See also
CDirectionalLEDMedium

Definition at line 114 of file directional_led_entity.cpp.

Member Data Documentation

CColor argos::CDirectionalLEDEntity::m_cColor
protected

Definition at line 131 of file directional_led_entity.h.

CColor argos::CDirectionalLEDEntity::m_cInitColor
protected

Definition at line 132 of file directional_led_entity.h.

CRadians argos::CDirectionalLEDEntity::m_cObservableAngle
protected

Definition at line 130 of file directional_led_entity.h.

CDirectionalLEDMedium* argos::CDirectionalLEDEntity::m_pcMedium
protected

Definition at line 133 of file directional_led_entity.h.