argos::CCI_TagsActuator Class Reference

#include <ci_tags_actuator.h>

Inheritance diagram for argos::CCI_TagsActuator:
Collaboration diagram for argos::CCI_TagsActuator:

Public Types

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
 

Public Member Functions

 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 Init (TConfigurationNode &t_node)
 Initializes the actuator from the XML configuration tree. 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::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Protected Attributes

TSettings m_tSettings
 

Detailed Description

Definition at line 18 of file ci_tags_actuator.h.

Member Typedef Documentation

◆ TSettings

typedef std::vector<std::string> argos::CCI_TagsActuator::TSettings

Definition at line 22 of file ci_tags_actuator.h.

Constructor & Destructor Documentation

◆ CCI_TagsActuator()

argos::CCI_TagsActuator::CCI_TagsActuator ( )
inline

Definition at line 26 of file ci_tags_actuator.h.

◆ ~CCI_TagsActuator()

virtual argos::CCI_TagsActuator::~CCI_TagsActuator ( )
inlinevirtual

Definition at line 28 of file ci_tags_actuator.h.

Member Function Documentation

◆ GetNumTags()

size_t argos::CCI_TagsActuator::GetNumTags ( ) const

Returns the number of tags.

Definition at line 67 of file ci_tags_actuator.cpp.

◆ SetAllPayloads()

void argos::CCI_TagsActuator::SetAllPayloads ( const std::string &  str_payload)
virtual

Sets all the tags with the same payload.

Parameters
str_payloadPayload to set

Definition at line 82 of file ci_tags_actuator.cpp.

◆ SetSinglePayload()

void argos::CCI_TagsActuator::SetSinglePayload ( UInt32  un_tag_number,
const std::string &  str_payload 
)
virtual

Sets the payload of a single tag.

Parameters
un_tag_numberTag that must be set
str_payloadPayload to set

Definition at line 74 of file ci_tags_actuator.cpp.

Member Data Documentation

◆ m_tSettings

TSettings argos::CCI_TagsActuator::m_tSettings
protected

Definition at line 58 of file ci_tags_actuator.h.