argos::CLightEntity Class Reference

#include <light_entity.h>

Inheritance diagram for argos::CLightEntity:
Collaboration diagram for argos::CLightEntity:

Public Member Functions

 ENABLE_VTABLE ()
 
 CLightEntity ()
 
 CLightEntity (const std::string &str_id, const CVector3 &c_position, const CColor &c_color, Real f_intensity)
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
Real GetIntensity () const
 
void SetIntensity (Real f_intensity)
 
virtual std::string GetTypeDescription () const
 Returns a string label for this class. More...
 
- Public Member Functions inherited from argos::CLEDEntity
 ENABLE_VTABLE ()
 
 CLEDEntity (CComposableEntity *pc_parent)
 
 CLEDEntity (CComposableEntity *pc_parent, const std::string &str_id, const CVector3 &c_position, const CColor &c_color)
 
virtual ~CLEDEntity ()
 
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 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...
 
bool HasMedium () const
 Returns true if this LED is associated to a medium. More...
 
CLEDMediumGetMedium () const
 Returns the medium associated to this LED. More...
 
void SetMedium (CLEDMedium &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

Real m_fIntensity
 
- Protected Attributes inherited from argos::CLEDEntity
CColor m_cColor
 
CColor m_cInitColor
 
CLEDMediumm_pcMedium
 

Additional Inherited Members

- Public Types inherited from argos::CLEDEntity
typedef std::vector< CLEDEntity * > TList
 
typedef CSet< CLEDEntity * > 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...
 

Detailed Description

Definition at line 20 of file light_entity.h.

Constructor & Destructor Documentation

argos::CLightEntity::CLightEntity ( )

Definition at line 17 of file light_entity.cpp.

argos::CLightEntity::CLightEntity ( const std::string &  str_id,
const CVector3 c_position,
const CColor c_color,
Real  f_intensity 
)

Definition at line 24 of file light_entity.cpp.

Member Function Documentation

argos::CLightEntity::ENABLE_VTABLE ( )
Real argos::CLightEntity::GetIntensity ( ) const
inline

Definition at line 37 of file light_entity.h.

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

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CLEDEntity.

Definition at line 45 of file light_entity.h.

void argos::CLightEntity::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::CLEDEntity.

Definition at line 37 of file light_entity.cpp.

void argos::CLightEntity::SetIntensity ( Real  f_intensity)
inline

Definition at line 41 of file light_entity.h.

Member Data Documentation

Real argos::CLightEntity::m_fIntensity
protected

Definition at line 51 of file light_entity.h.