ARGoS
3
A parallel, multi-engine simulator for swarm robotics
|
The basic interface for all actuators. More...
#include <ci_actuator.h>
Public Types | |
typedef std::map< std::string, CCI_Actuator *, std::less < std::string > > | TMap |
Public Member Functions | |
virtual | ~CCI_Actuator () |
Class destructor. | |
virtual void | Init (TConfigurationNode &t_node) |
Initializes the actuator from the XML configuration tree. | |
virtual void | Reset () |
Resets the actuator to the state it had just after Init(). | |
virtual void | Destroy () |
Destroys the actuator. | |
virtual void | CreateLuaState (lua_State *pt_lua_state)=0 |
Creates the Lua state for this actuator. |
The basic interface for all actuators.
Definition at line 34 of file ci_actuator.h.
typedef std::map<std::string, CCI_Actuator*, std::less<std::string> > argos::CCI_Actuator::TMap |
Definition at line 38 of file ci_actuator.h.
virtual argos::CCI_Actuator::~CCI_Actuator | ( | ) | [inline, virtual] |
Class destructor.
Definition at line 45 of file ci_actuator.h.
virtual void argos::CCI_Actuator::CreateLuaState | ( | lua_State * | pt_lua_state | ) | [pure virtual] |
Creates the Lua state for this actuator.
The state must be added to the robot
table, as a nested table.
pt_lua_state | The current Lua state. |
virtual void argos::CCI_Actuator::Destroy | ( | ) | [inline, virtual] |
Destroys the actuator.
This method is supposed to undo whatever was done in Init(). The default implementation of this method does nothing.
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 | ) | [inline, virtual] |
Initializes the actuator from the XML configuration tree.
The default implementation of this method does nothing.
t_node | The XML configuration tree relative to this actuator. |
Implements argos::CBaseConfigurableResource.
Reimplemented in argos::CDifferentialSteeringDefaultActuator, and argos::CLEDsDefaultActuator.
Definition at line 54 of file ci_actuator.h.
virtual void argos::CCI_Actuator::Reset | ( | ) | [inline, virtual] |
Resets the actuator to the state it had just after Init().
The default implementation of this method does nothing.
Implements argos::CBaseConfigurableResource.
Reimplemented in argos::CDifferentialSteeringDefaultActuator, argos::CFootBotDistanceScannerDefaultActuator, argos::CFootBotTurretDefaultActuator, argos::CLEDsDefaultActuator, argos::CFootBotGripperDefaultActuator, argos::CGripperDefaultActuator, and argos::CRangeAndBearingDefaultActuator.
Definition at line 62 of file ci_actuator.h.