argos::CQuadRotorPositionDefaultActuator Class Reference

#include <quadrotor_position_default_actuator.h>

Inheritance diagram for argos::CQuadRotorPositionDefaultActuator:
Collaboration diagram for argos::CQuadRotorPositionDefaultActuator:

Public Member Functions

 CQuadRotorPositionDefaultActuator ()
 
virtual ~CQuadRotorPositionDefaultActuator ()
 
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 SetAbsolutePosition (const CVector3 &c_pos)
 Sets the absolute position of the robot in the environment. More...
 
virtual void SetRelativePosition (const CVector3 &c_pos)
 Sets the position of the robot in the environment relative to the current position and attitude. More...
 
virtual void SetAbsoluteYaw (const CRadians &c_yaw)
 Sets the absolute yaw of the robot in the world. More...
 
virtual void SetRelativeYaw (const CRadians &c_yaw)
 Sets the yaw of the robot in the environment relative to the current position and attitude. 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_QuadRotorPositionActuator
virtual ~CCI_QuadRotorPositionActuator ()
 
- 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

CQuadRotorEntitym_pcQuadRotorEntity
 
CEmbodiedEntitym_pcEmbodiedEntity
 
CQuadRotorEntity::SPositionControlData m_sDesiredPosData
 

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 25 of file quadrotor_position_default_actuator.h.

Constructor & Destructor Documentation

argos::CQuadRotorPositionDefaultActuator::CQuadRotorPositionDefaultActuator ( )

Definition at line 15 of file quadrotor_position_default_actuator.cpp.

virtual argos::CQuadRotorPositionDefaultActuator::~CQuadRotorPositionDefaultActuator ( )
inlinevirtual

Definition at line 31 of file quadrotor_position_default_actuator.h.

Member Function Documentation

void argos::CQuadRotorPositionDefaultActuator::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 45 of file quadrotor_position_default_actuator.cpp.

void argos::CQuadRotorPositionDefaultActuator::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 97 of file quadrotor_position_default_actuator.cpp.

void argos::CQuadRotorPositionDefaultActuator::SetAbsolutePosition ( const CVector3 c_pos)
virtual

Sets the absolute position of the robot in the environment.

Parameters
c_posThe desired absolute position.

Implements argos::CCI_QuadRotorPositionActuator.

Definition at line 58 of file quadrotor_position_default_actuator.cpp.

void argos::CQuadRotorPositionDefaultActuator::SetAbsoluteYaw ( const CRadians c_yaw)
virtual

Sets the absolute yaw of the robot in the world.

Parameters
c_orientThe desired absulte yaw.

Implements argos::CCI_QuadRotorPositionActuator.

Definition at line 74 of file quadrotor_position_default_actuator.cpp.

void argos::CQuadRotorPositionDefaultActuator::SetRelativePosition ( const CVector3 c_pos)
virtual

Sets the position of the robot in the environment relative to the current position and attitude.

Parameters
c_posThe desired relative position.

Implements argos::CCI_QuadRotorPositionActuator.

Definition at line 65 of file quadrotor_position_default_actuator.cpp.

void argos::CQuadRotorPositionDefaultActuator::SetRelativeYaw ( const CRadians c_yaw)
virtual

Sets the yaw of the robot in the environment relative to the current position and attitude.

Parameters
c_orientThe desired relative yaw.

Implements argos::CCI_QuadRotorPositionActuator.

Definition at line 81 of file quadrotor_position_default_actuator.cpp.

void argos::CQuadRotorPositionDefaultActuator::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 22 of file quadrotor_position_default_actuator.cpp.

void argos::CQuadRotorPositionDefaultActuator::Update ( )
virtual

Updates the state of the entity associated to this actuator.

Implements argos::CSimulatedActuator.

Definition at line 90 of file quadrotor_position_default_actuator.cpp.

Member Data Documentation

CEmbodiedEntity* argos::CQuadRotorPositionDefaultActuator::m_pcEmbodiedEntity
protected

Definition at line 48 of file quadrotor_position_default_actuator.h.

CQuadRotorEntity* argos::CQuadRotorPositionDefaultActuator::m_pcQuadRotorEntity
protected

Definition at line 47 of file quadrotor_position_default_actuator.h.

CQuadRotorEntity::SPositionControlData argos::CQuadRotorPositionDefaultActuator::m_sDesiredPosData
protected

Definition at line 49 of file quadrotor_position_default_actuator.h.