argos::CLEDsDefaultActuator Class Reference

#include <leds_default_actuator.h>

Inheritance diagram for argos::CLEDsDefaultActuator:
Collaboration diagram for argos::CLEDsDefaultActuator:

Public Member Functions

 CLEDsDefaultActuator ()
 
virtual ~CLEDsDefaultActuator ()
 
virtual void SetRobot (CComposableEntity &c_entity)
 Sets the entity associated to this actuator. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the actuator from the XML configuration tree. More...
 
virtual void Update ()
 Updates the state of the entity associated to this actuator. More...
 
virtual void Reset ()
 Resets the actuator to the state it had just after Init(). More...
 
virtual void Destroy ()
 Destroys the actuator. More...
 
- Public Member Functions inherited from argos::CSimulatedActuator
virtual ~CSimulatedActuator ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CCI_LEDsActuator
 CCI_LEDsActuator ()
 
virtual ~CCI_LEDsActuator ()
 
size_t GetNumLEDs () const
 Returns the number of LEDs. More...
 
virtual void SetSingleColor (UInt32 un_led_number, const CColor &c_color)
 Sets the color of a single LED. More...
 
virtual void SetAllColors (const CColor &c_color)
 Sets the color of the whole LED ring. More...
 
virtual void SetAllColors (const TSettings &c_colors)
 Sets the color of the whole LED ring. More...
 
virtual void SetSingleIntensity (UInt32 un_led_number, UInt8 un_intensity)
 Sets the intensity of a single LED in the ring. More...
 
virtual void SetAllIntensities (UInt8 un_intensity)
 Sets the intensity of all the LEDs in the ring. More...
 
- Public Member Functions inherited from argos::CCI_Actuator
virtual ~CCI_Actuator ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Additional Inherited Members

- Public Types inherited from argos::CCI_LEDsActuator
typedef std::vector< CColorTSettings
 
- Public Types inherited from argos::CCI_Actuator
typedef std::map< std::string, CCI_Actuator *, std::less< std::string > > TMap
 
- Protected Attributes inherited from argos::CCI_LEDsActuator
TSettings m_tSettings
 

Detailed Description

Definition at line 24 of file leds_default_actuator.h.

Constructor & Destructor Documentation

argos::CLEDsDefaultActuator::CLEDsDefaultActuator ( )

Definition at line 17 of file leds_default_actuator.cpp.

virtual argos::CLEDsDefaultActuator::~CLEDsDefaultActuator ( )
inlinevirtual

Definition at line 31 of file leds_default_actuator.h.

Member Function Documentation

void argos::CLEDsDefaultActuator::Destroy ( )
virtual

Destroys the actuator.

This method is supposed to undo whatever was done in Init(). The default implementation of this method does nothing.

See also
Init()
Reset()

Reimplemented from argos::CCI_Actuator.

Definition at line 62 of file leds_default_actuator.cpp.

void argos::CLEDsDefaultActuator::Init ( TConfigurationNode t_node)
virtual

Initializes the actuator from the XML configuration tree.

The default implementation of this method does nothing.

Parameters
t_nodeThe XML configuration tree relative to this actuator.
See also
Reset()
Destroy()

Reimplemented from argos::CCI_Actuator.

Definition at line 31 of file leds_default_actuator.cpp.

void argos::CLEDsDefaultActuator::Reset ( )
virtual

Resets the actuator to the state it had just after Init().

The default implementation of this method does nothing.

See also
Init()
Destroy()

Reimplemented from argos::CCI_Actuator.

Definition at line 55 of file leds_default_actuator.cpp.

void argos::CLEDsDefaultActuator::SetRobot ( CComposableEntity c_entity)
virtual

Sets the entity associated to this actuator.

When a controller is created, all the sensors and actuators are created, too. This function is called right before the Init() method of the actuator is called.

Parameters
c_entityThe entity to associate to this actuator.
See also
CComposableEntity
CControllableEntity::SetController()
CCI_Actuator::Init()

Implements argos::CSimulatedActuator.

Definition at line 23 of file leds_default_actuator.cpp.

void argos::CLEDsDefaultActuator::Update ( )
virtual

Updates the state of the entity associated to this actuator.

Implements argos::CSimulatedActuator.

Definition at line 48 of file leds_default_actuator.cpp.