argos::CCI_Actuator Class Reference

The basic interface for all actuators. More...

#include <ci_actuator.h>

Inheritance diagram for argos::CCI_Actuator:
Collaboration diagram for argos::CCI_Actuator:

Public Types

typedef std::map< std::string, CCI_Actuator *, std::less< std::string > > TMap
 

Public Member Functions

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

Detailed Description

The basic interface for all actuators.

Definition at line 34 of file ci_actuator.h.

Member Typedef Documentation

typedef std::map<std::string, CCI_Actuator*, std::less<std::string> > argos::CCI_Actuator::TMap

Definition at line 38 of file ci_actuator.h.

Constructor & Destructor Documentation

virtual argos::CCI_Actuator::~CCI_Actuator ( )
inlinevirtual

Class destructor.

Definition at line 45 of file ci_actuator.h.

Member Function Documentation

virtual void argos::CCI_Actuator::Destroy ( )
inlinevirtual

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

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CLEDsDefaultActuator.

Definition at line 71 of file ci_actuator.h.

virtual void argos::CCI_Actuator::Init ( TConfigurationNode t_node)
inlinevirtual

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

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CDifferentialSteeringDefaultActuator, argos::CMiniQuadrotorRotorDefaultActuator, argos::CPrototypeJointsDefaultActuator, argos::CDirectionalLEDsDefaultActuator, argos::CLEDsDefaultActuator, argos::CQuadRotorPositionDefaultActuator, argos::CQuadRotorSpeedDefaultActuator, argos::CMagnetsDefaultActuator, and argos::CRadiosDefaultActuator.

Definition at line 54 of file ci_actuator.h.