A container of CDirectionalLEDEntity. More...

#include <directional_led_equipped_entity.h>

Inheritance diagram for argos::CDirectionalLEDEquippedEntity:

[legend]

Collaboration diagram for argos::CDirectionalLEDEquippedEntity:

[legend]

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 ()

void	AddLED (const std::string &str_id, const CVector3 &c_position, const CQuaternion &c_orientation, SAnchor &s_anchor, const CRadians &c_observable_angle, const CColor &c_color)
	Programmatically creates a new directional LED. More...

CDirectionalLEDEntity &	GetLED (UInt32 un_index)
	Returns an LED by numeric index. More...

const CDirectionalLEDEntity &	GetLED (UInt32 un_index) const
	Returns an LED by numeric index as a const reference. More...

SInstance::TVector &	GetInstances ()
	Returns all the LEDs. More...

const SInstance::TVector &	GetInstances () 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...

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...

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...

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...

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...

TConfigurationNode *	GetConfigurationNode ()
	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

◆ CDirectionalLEDEquippedEntity() [1/2]

argos::CDirectionalLEDEquippedEntity::CDirectionalLEDEquippedEntity ( CComposableEntity * pc_parent )

Class constructor.

Parameters

pc_parent The parent entity.

Definition at line 29 of file directional_led_equipped_entity.cpp.

◆ CDirectionalLEDEquippedEntity() [2/2]

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

Class constructor.

Parameters

pc_parent	The parent entity.
str_id	The id of this entity.

Definition at line 37 of file directional_led_equipped_entity.cpp.

◆ ~CDirectionalLEDEquippedEntity()

virtual argos::CDirectionalLEDEquippedEntity::~CDirectionalLEDEquippedEntity ( )

inlinevirtual

Definition at line 67 of file directional_led_equipped_entity.h.

Member Function Documentation

◆ AddLED()

void argos::CDirectionalLEDEquippedEntity::AddLED	(	const std::string &	str_id,
		const CVector3 &	c_position,
		const CQuaternion &	c_orientation,
		SAnchor &	s_anchor,
		const CRadians &	c_observable_angle,
		const CColor &	c_color
	)

Programmatically creates a new directional LED.

Parameters

str_id	The identifier of the LED.
c_position	The position of the LED.
c_orientation	The orientation of the LED.
s_anchor	The anchor of the LED.
c_observable_angle	The observable angle of the LED.
c_color	The color of the LED.

See also: GetInstances(); GetLED()

Definition at line 93 of file directional_led_equipped_entity.cpp.

◆ Disable()

void argos::CDirectionalLEDEquippedEntity::Disable ( )

virtual

Definition at line 132 of file directional_led_equipped_entity.cpp.

◆ Enable()

void argos::CDirectionalLEDEquippedEntity::Enable ( )

virtual

Definition at line 120 of file directional_led_equipped_entity.cpp.

◆ ENABLE_VTABLE()

argos::CDirectionalLEDEquippedEntity::ENABLE_VTABLE ( )

◆ GetInstances() [1/2]

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

inline

Returns all the LEDs.

Returns: All the LEDs.

See also: GetInstances()

Definition at line 114 of file directional_led_equipped_entity.h.

◆ GetInstances() [2/2]

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 123 of file directional_led_equipped_entity.h.

◆ GetLED() [1/2]

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

Returns an LED by numeric index.

Parameters

un_index The index of the wanted LED.

Returns: An LED by numeric index.

See also: GetInstances()

Definition at line 144 of file directional_led_equipped_entity.cpp.

◆ GetLED() [2/2]

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

Returns an LED by numeric index as a const reference.

Parameters

un_index The index of the wanted LED.

Returns: An LED as a const reference.

See also: GetInstances()

Definition at line 158 of file directional_led_equipped_entity.cpp.

◆ GetTypeDescription()

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 157 of file directional_led_equipped_entity.h.

◆ Init()

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

CARGoSException if a parse error occurred

Reimplemented from argos::CEntity.

Definition at line 46 of file directional_led_equipped_entity.cpp.

◆ SetLEDColor()

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

Sets the color of an LED.

Parameters

un_index	The index of the wanted LED.
c_color	The color of the LED.

Definition at line 172 of file directional_led_equipped_entity.cpp.

◆ SetLEDColors() [1/2]

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

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

Parameters

c_color The color of the LEDs.

See also: SetLEDColors()

Definition at line 187 of file directional_led_equipped_entity.cpp.

◆ SetLEDColors() [2/2]

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

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

Parameters

vec_colors A vector containing the colors of the LEDs.

See also: SetLEDColors()

Exceptions

CARGoSException if the size of the passed vector is different from the number of LED.

Definition at line 196 of file directional_led_equipped_entity.cpp.

◆ SetMedium()

void argos::CDirectionalLEDEquippedEntity::SetMedium ( CDirectionalLEDMedium & c_medium )

Sets the medium associated to this entity.

Parameters

c_medium The medium to associate to this entity.

See also: CDirectionalLEDMedium

Definition at line 236 of file directional_led_equipped_entity.cpp.

◆ UpdateComponents()

void argos::CDirectionalLEDEquippedEntity::UpdateComponents ( )

protectedvirtual

Calls the Update() method on all the components.

See also: Update()

Reimplemented from argos::CComposableEntity.

Definition at line 217 of file directional_led_equipped_entity.cpp.

Member Data Documentation

◆ m_vecInstances

SInstance::TVector argos::CDirectionalLEDEquippedEntity::m_vecInstances

protected

List of the LEDs managed by this entity.

Definition at line 168 of file directional_led_equipped_entity.h.

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CDirectionalLEDEquippedEntity() [1/2]

◆ CDirectionalLEDEquippedEntity() [2/2]

◆ ~CDirectionalLEDEquippedEntity()

Member Function Documentation

◆ AddLED()

◆ Disable()

◆ Enable()

◆ ENABLE_VTABLE()

◆ GetInstances() [1/2]

◆ GetInstances() [2/2]

◆ GetLED() [1/2]

◆ GetLED() [2/2]

◆ GetTypeDescription()

◆ Init()

◆ SetLEDColor()

◆ SetLEDColors() [1/2]

◆ SetLEDColors() [2/2]

◆ SetMedium()

◆ UpdateComponents()

Member Data Documentation

◆ m_vecInstances