argos::CTagsDefaultActuator Class Reference

#include <tags_default_actuator.h>

Inheritance diagram for argos::CTagsDefaultActuator:
Collaboration diagram for argos::CTagsDefaultActuator:

Public Member Functions

 CTagsDefaultActuator ()
 
virtual ~CTagsDefaultActuator ()
 
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...
 
- Public Member Functions inherited from argos::CSimulatedActuator
virtual ~CSimulatedActuator ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CCI_TagsActuator
 CCI_TagsActuator ()
 
virtual ~CCI_TagsActuator ()
 
size_t GetNumTags () const
 Returns the number of tags. More...
 
virtual void SetSinglePayload (UInt32 un_tag_number, const std::string &str_payload)
 Sets the payload of a single tag. More...
 
virtual void SetAllPayloads (const std::string &str_payload)
 Sets all the tags with the same payload. More...
 
- Public Member Functions inherited from argos::CCI_Actuator
virtual ~CCI_Actuator ()
 Class destructor. More...
 
virtual void Destroy ()
 Destroys the actuator. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Additional Inherited Members

- Public Types inherited from argos::CCI_TagsActuator
typedef std::vector< std::string > TSettings
 
- 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_TagsActuator
TSettings m_tSettings
 

Detailed Description

Definition at line 24 of file tags_default_actuator.h.

Constructor & Destructor Documentation

◆ CTagsDefaultActuator()

argos::CTagsDefaultActuator::CTagsDefaultActuator ( )

Definition at line 16 of file tags_default_actuator.cpp.

◆ ~CTagsDefaultActuator()

virtual argos::CTagsDefaultActuator::~CTagsDefaultActuator ( )
inlinevirtual

Definition at line 31 of file tags_default_actuator.h.

Member Function Documentation

◆ Init()

void argos::CTagsDefaultActuator::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 tags_default_actuator.cpp.

◆ Reset()

void argos::CTagsDefaultActuator::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 50 of file tags_default_actuator.cpp.

◆ SetRobot()

void argos::CTagsDefaultActuator::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 22 of file tags_default_actuator.cpp.

◆ Update()

void argos::CTagsDefaultActuator::Update ( )
virtual

Updates the state of the entity associated to this actuator.

Implements argos::CSimulatedActuator.

Definition at line 43 of file tags_default_actuator.cpp.