Warning: include(php/utility.php): Failed to open stream: No such file or directory in /home/argos/argos3/doc/api/embedded/a00274.php on line 2

Warning: include(): Failed opening 'php/utility.php' for inclusion (include_path='.:/usr/lib64/php') in /home/argos/argos3/doc/api/embedded/a00274.php on line 2
The ARGoS Website

argos::CRadiosDefaultActuator Class Reference

#include <radios_default_actuator.h>

Inheritance diagram for argos::CRadiosDefaultActuator:
Collaboration diagram for argos::CRadiosDefaultActuator:

Public Member Functions

 CRadiosDefaultActuator ()
 
virtual ~CRadiosDefaultActuator ()
 
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_RadiosActuator
 CCI_RadiosActuator ()
 Constructor. More...
 
virtual ~CCI_RadiosActuator ()
 Destructor. More...
 
SInterface::TVectorGetInterfaces ()
 Returns a reference to the radio interfaces. 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...
 

Protected Attributes

CRadioEquippedEntitym_pcRadioEquippedEntity
 
- Protected Attributes inherited from argos::CCI_RadiosActuator
SInterface::TVector m_vecInterfaces
 

Additional Inherited Members

- Public Types inherited from argos::CCI_Actuator
typedef std::map< std::string, CCI_Actuator *, std::less< std::string > > TMap
 

Detailed Description

Definition at line 20 of file radios_default_actuator.h.

Constructor & Destructor Documentation

argos::CRadiosDefaultActuator::CRadiosDefaultActuator ( )

Definition at line 50 of file radios_default_actuator.cpp.

virtual argos::CRadiosDefaultActuator::~CRadiosDefaultActuator ( )
inlinevirtual

Definition at line 27 of file radios_default_actuator.h.

Member Function Documentation

void argos::CRadiosDefaultActuator::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 76 of file radios_default_actuator.cpp.

void argos::CRadiosDefaultActuator::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 111 of file radios_default_actuator.cpp.

void argos::CRadiosDefaultActuator::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 57 of file radios_default_actuator.cpp.

void argos::CRadiosDefaultActuator::Update ( )
virtual

Updates the state of the entity associated to this actuator.

Implements argos::CSimulatedActuator.

Definition at line 90 of file radios_default_actuator.cpp.

Member Data Documentation

CRadioEquippedEntity* argos::CRadiosDefaultActuator::m_pcRadioEquippedEntity
protected

Definition at line 39 of file radios_default_actuator.h.