argos::CDirectionalLEDEquippedEntity Class Reference

A container of CDirectionalLEDEntity. More...

#include <directional_led_equipped_entity.h>

Inheritance diagram for argos::CDirectionalLEDEquippedEntity:
Collaboration diagram for argos::CDirectionalLEDEquippedEntity:

Classes

struct  SInstance
 

Public Member Functions

 ENABLE_VTABLE ()
 
 CDirectionalLEDEquippedEntity (CComposableEntity *pc_parent)
 Class constructor. More...
 
 CDirectionalLEDEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id)
 Class constructor. More...
 
virtual ~CDirectionalLEDEquippedEntity ()
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
virtual void Enable ()
 
virtual void Disable ()
 
CDirectionalLEDEntityGetLED (UInt32 un_index)
 Returns an LED by numeric index. More...
 
SInstance::TVectorGetInstances ()
 Returns all the LEDs. More...
 
const SInstance::TVectorGetInstances () const
 Returns the LEDs as a const reference. More...
 
void SetLEDColor (UInt32 un_index, const CColor &c_color)
 Sets the color of an LED. More...
 
void SetLEDColors (const CColor &c_color)
 Sets the color of all the LEDs to the same value. More...
 
void SetLEDColors (const std::vector< CColor > &vec_colors)
 Sets the color of all the LEDs to the given setting. More...
 
void SetMedium (CDirectionalLEDMedium &c_medium)
 Sets the medium associated to this entity. More...
 
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 Reset ()
 Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. 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...
 
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...
 
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 Member Functions

virtual void UpdateComponents ()
 Calls the Update() method on all the components. More...
 

Protected Attributes

SInstance::TVector m_vecInstances
 List of the LEDs managed by this entity. 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

A container of CDirectionalLEDEntity.

This is a convenience class that acts a container of CDirectionalLEDEntity objects. It is mostly useful when a robot is equipped with a number of LEDs, and you want to manage them comfortably.

See also
CDirectionalLEDEntity

Definition at line 30 of file directional_led_equipped_entity.h.

Constructor & Destructor Documentation

argos::CDirectionalLEDEquippedEntity::CDirectionalLEDEquippedEntity ( CComposableEntity pc_parent)

Class constructor.

Parameters
pc_parentThe parent entity.

Definition at line 29 of file directional_led_equipped_entity.cpp.

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

Class constructor.

Parameters
pc_parentThe parent entity.
str_idThe id of this entity.

Definition at line 37 of file directional_led_equipped_entity.cpp.

virtual argos::CDirectionalLEDEquippedEntity::~CDirectionalLEDEquippedEntity ( )
inlinevirtual

Definition at line 67 of file directional_led_equipped_entity.h.

Member Function Documentation

void argos::CDirectionalLEDEquippedEntity::Disable ( )
virtual

Definition at line 105 of file directional_led_equipped_entity.cpp.

void argos::CDirectionalLEDEquippedEntity::Enable ( )
virtual

Definition at line 93 of file directional_led_equipped_entity.cpp.

argos::CDirectionalLEDEquippedEntity::ENABLE_VTABLE ( )
SInstance::TVector& argos::CDirectionalLEDEquippedEntity::GetInstances ( )
inline

Returns all the LEDs.

Returns
All the LEDs.
See also
GetInstances()

Definition at line 88 of file directional_led_equipped_entity.h.

const SInstance::TVector& argos::CDirectionalLEDEquippedEntity::GetInstances ( ) const
inline

Returns the LEDs as a const reference.

Returns
The LEDs as a const reference.
See also
GetInstances()

Definition at line 97 of file directional_led_equipped_entity.h.

CDirectionalLEDEntity & argos::CDirectionalLEDEquippedEntity::GetLED ( UInt32  un_index)

Returns an LED by numeric index.

Parameters
un_indexThe index of the wanted LED.
Returns
An LED by numeric index.
See also
GetLEDs()

Definition at line 117 of file directional_led_equipped_entity.cpp.

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

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CComposableEntity.

Definition at line 131 of file directional_led_equipped_entity.h.

void argos::CDirectionalLEDEquippedEntity::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 46 of file directional_led_equipped_entity.cpp.

void argos::CDirectionalLEDEquippedEntity::SetLEDColor ( UInt32  un_index,
const CColor c_color 
)

Sets the color of an LED.

Parameters
un_indexThe index of the wanted LED.
c_colorThe color of the LED.

Definition at line 131 of file directional_led_equipped_entity.cpp.

void argos::CDirectionalLEDEquippedEntity::SetLEDColors ( const CColor c_color)

Sets the color of all the LEDs to the same value.

Parameters
c_colorThe color of the LEDs.
See also
SetLEDColors()

Definition at line 146 of file directional_led_equipped_entity.cpp.

void argos::CDirectionalLEDEquippedEntity::SetLEDColors ( const std::vector< CColor > &  vec_colors)

Sets the color of all the LEDs to the given setting.

Parameters
vec_colorsA vector containing the colors of the LEDs.
See also
SetLEDColors()
Exceptions
CARGoSExceptionif the size of the passed vector is different from the number of LED.

Definition at line 155 of file directional_led_equipped_entity.cpp.

void argos::CDirectionalLEDEquippedEntity::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 195 of file directional_led_equipped_entity.cpp.

void argos::CDirectionalLEDEquippedEntity::UpdateComponents ( )
protectedvirtual

Calls the Update() method on all the components.

See also
Update()

Reimplemented from argos::CComposableEntity.

Definition at line 176 of file directional_led_equipped_entity.cpp.

Member Data Documentation

SInstance::TVector argos::CDirectionalLEDEquippedEntity::m_vecInstances
protected

List of the LEDs managed by this entity.

Definition at line 142 of file directional_led_equipped_entity.h.