argos::CQuadRotorSpeedDefaultActuator Class Reference

#include <quadrotor_speed_default_actuator.h>

Inheritance diagram for argos::CQuadRotorSpeedDefaultActuator:
Collaboration diagram for argos::CQuadRotorSpeedDefaultActuator:

Public Member Functions

 CQuadRotorSpeedDefaultActuator ()
 
virtual ~CQuadRotorSpeedDefaultActuator ()
 
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 SetLinearVelocity (const CVector3 &c_velocity)
 Sets the linear velocity of the quadrotor. More...
 
virtual void SetRotationalSpeed (const CRadians &c_speed)
 Sets the rotational velocity of the quadrotor around the local Z axis (yaw). 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_QuadRotorSpeedActuator
virtual ~CCI_QuadRotorSpeedActuator ()
 
- 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::SSpeedControlData m_sDesiredSpeedData
 

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

Constructor & Destructor Documentation

◆ CQuadRotorSpeedDefaultActuator()

argos::CQuadRotorSpeedDefaultActuator::CQuadRotorSpeedDefaultActuator ( )

Definition at line 15 of file quadrotor_speed_default_actuator.cpp.

◆ ~CQuadRotorSpeedDefaultActuator()

virtual argos::CQuadRotorSpeedDefaultActuator::~CQuadRotorSpeedDefaultActuator ( )
inlinevirtual

Definition at line 31 of file quadrotor_speed_default_actuator.h.

Member Function Documentation

◆ Init()

void argos::CQuadRotorSpeedDefaultActuator::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_speed_default_actuator.cpp.

◆ Reset()

void argos::CQuadRotorSpeedDefaultActuator::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 79 of file quadrotor_speed_default_actuator.cpp.

◆ SetLinearVelocity()

void argos::CQuadRotorSpeedDefaultActuator::SetLinearVelocity ( const CVector3 c_velocity)
virtual

Sets the linear velocity of the quadrotor.

Parameters
c_velocityThe desired linear velocity.

Implements argos::CCI_QuadRotorSpeedActuator.

Definition at line 58 of file quadrotor_speed_default_actuator.cpp.

◆ SetRobot()

void argos::CQuadRotorSpeedDefaultActuator::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_speed_default_actuator.cpp.

◆ SetRotationalSpeed()

void argos::CQuadRotorSpeedDefaultActuator::SetRotationalSpeed ( const CRadians c_speed)
virtual

Sets the rotational velocity of the quadrotor around the local Z axis (yaw).

Parameters
c_velocityThe desired rotational velocity.

Implements argos::CCI_QuadRotorSpeedActuator.

Definition at line 65 of file quadrotor_speed_default_actuator.cpp.

◆ Update()

void argos::CQuadRotorSpeedDefaultActuator::Update ( )
virtual

Updates the state of the entity associated to this actuator.

Implements argos::CSimulatedActuator.

Definition at line 72 of file quadrotor_speed_default_actuator.cpp.

Member Data Documentation

◆ m_pcEmbodiedEntity

CEmbodiedEntity* argos::CQuadRotorSpeedDefaultActuator::m_pcEmbodiedEntity
protected

Definition at line 46 of file quadrotor_speed_default_actuator.h.

◆ m_pcQuadRotorEntity

CQuadRotorEntity* argos::CQuadRotorSpeedDefaultActuator::m_pcQuadRotorEntity
protected

Definition at line 45 of file quadrotor_speed_default_actuator.h.

◆ m_sDesiredSpeedData

CQuadRotorEntity::SSpeedControlData argos::CQuadRotorSpeedDefaultActuator::m_sDesiredSpeedData
protected

Definition at line 47 of file quadrotor_speed_default_actuator.h.