argos::CSimulatedActuator Class Reference

The basic interface for a simulated actuator. More...

#include <actuator.h>

Inheritance diagram for argos::CSimulatedActuator:

Public Member Functions
virtual	~CSimulatedActuator ()
	Class destructor. More...
virtual void	SetRobot (CComposableEntity &c_entity)=0
	Sets the entity associated to this actuator. More...
virtual void	Update ()=0
	Updates the state of the entity associated to this actuator. More...

Detailed Description

The basic interface for a simulated actuator.

To implement the simulated model of an actuator, you must define a class that inherits from both the control interface and this class.

See also

CCI_Actuator

Definition at line 24 of file actuator.h.

Constructor & Destructor Documentation

~CSimulatedActuator()

virtual argos::CSimulatedActuator::~CSimulatedActuator ( )

inlinevirtual

Class destructor.

Definition at line 31 of file actuator.h.

Member Function Documentation

SetRobot()

virtual void argos::CSimulatedActuator::SetRobot ( CComposableEntity &  c_entity )

pure 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_entity

The entity to associate to this actuator.

See also

CComposableEntity

CControllableEntity::SetController()

CCI_Actuator::Init()

Implemented in argos::CDifferentialSteeringDefaultActuator, argos::CMiniQuadrotorRotorDefaultActuator, argos::CPrototypeJointsDefaultActuator, argos::CFootBotDistanceScannerDefaultActuator, argos::CDirectionalLEDsDefaultActuator, argos::CLEDsDefaultActuator, argos::CQuadRotorPositionDefaultActuator, argos::CQuadRotorSpeedDefaultActuator, argos::CTagsDefaultActuator, argos::CFootBotGripperDefaultActuator, argos::CFootBotTurretDefaultActuator, argos::CGripperDefaultActuator, argos::CRadiosDefaultActuator, argos::CRangeAndBearingDefaultActuator, and argos::CMagnetsDefaultActuator.

Update()

virtual void argos::CSimulatedActuator::Update ( )

pure virtual

Updates the state of the entity associated to this actuator.

Implemented in argos::CDifferentialSteeringDefaultActuator, argos::CMiniQuadrotorRotorDefaultActuator, argos::CPrototypeJointsDefaultActuator, argos::CFootBotDistanceScannerDefaultActuator, argos::CQuadRotorPositionDefaultActuator, argos::CQuadRotorSpeedDefaultActuator, argos::CFootBotTurretDefaultActuator, argos::CDirectionalLEDsDefaultActuator, argos::CTagsDefaultActuator, argos::CLEDsDefaultActuator, argos::CFootBotGripperDefaultActuator, argos::CGripperDefaultActuator, argos::CRadiosDefaultActuator, argos::CMagnetsDefaultActuator, and argos::CRangeAndBearingDefaultActuator.