argos::CFootBotDistanceScannerDefaultActuator Class Reference

#include <footbot_distance_scanner_default_actuator.h>

Inheritance diagram for argos::CFootBotDistanceScannerDefaultActuator:
Collaboration diagram for argos::CFootBotDistanceScannerDefaultActuator:

Public Member Functions

 CFootBotDistanceScannerDefaultActuator ()
 
virtual ~CFootBotDistanceScannerDefaultActuator ()
 
virtual void SetRobot (CComposableEntity &c_entity)
 Sets the entity associated to this actuator. More...
 
virtual void SetAngle (const CRadians &c_angle)
 Sets the distance scanner angle The distance scanner can be controller in position or in speed. More...
 
virtual void SetRPM (Real f_rpm)
 Sets the distance scanner speed The distance scanner can be controller in position or in speed. More...
 
virtual void Enable ()
 Enables the distance scanner. More...
 
virtual void Disable ()
 Disables the distance scanner. 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_FootBotDistanceScannerActuator
virtual ~CCI_FootBotDistanceScannerActuator ()
 Destructor. More...
 
- Public Member Functions inherited from argos::CCI_Actuator
virtual ~CCI_Actuator ()
 Class destructor. More...
 
virtual void Init (TConfigurationNode &t_node)
 Initializes the actuator from the XML configuration tree. More...
 
virtual void Destroy ()
 Destroys the actuator. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Static Public Attributes

static const Real RPM_TO_RADIANS_PER_SEC = ARGOS_PI / 30.0f
 

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 24 of file footbot_distance_scanner_default_actuator.h.

Constructor & Destructor Documentation

argos::CFootBotDistanceScannerDefaultActuator::CFootBotDistanceScannerDefaultActuator ( )
virtual argos::CFootBotDistanceScannerDefaultActuator::~CFootBotDistanceScannerDefaultActuator ( )
inlinevirtual

Definition at line 32 of file footbot_distance_scanner_default_actuator.h.

Member Function Documentation

void argos::CFootBotDistanceScannerDefaultActuator::Disable ( )
virtual

Disables the distance scanner.

Implements argos::CCI_FootBotDistanceScannerActuator.

Definition at line 54 of file footbot_distance_scanner_default_actuator.cpp.

void argos::CFootBotDistanceScannerDefaultActuator::Enable ( )
virtual

Enables the distance scanner.

Implements argos::CCI_FootBotDistanceScannerActuator.

Definition at line 47 of file footbot_distance_scanner_default_actuator.cpp.

void argos::CFootBotDistanceScannerDefaultActuator::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 74 of file footbot_distance_scanner_default_actuator.cpp.

void argos::CFootBotDistanceScannerDefaultActuator::SetAngle ( const CRadians c_angle)
virtual

Sets the distance scanner angle The distance scanner can be controller in position or in speed.

This method allows you to set the desired angle of the ds

Parameters
c_angledesired distance scanner angle - radians

Implements argos::CCI_FootBotDistanceScannerActuator.

Definition at line 31 of file footbot_distance_scanner_default_actuator.cpp.

void argos::CFootBotDistanceScannerDefaultActuator::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 23 of file footbot_distance_scanner_default_actuator.cpp.

void argos::CFootBotDistanceScannerDefaultActuator::SetRPM ( Real  f_rpm)
virtual

Sets the distance scanner speed The distance scanner can be controller in position or in speed.

This method allows you to set the desired speed of the ds The speed is set in rounds per minutes, an OK value is 30rpm

Parameters
c_angledesired distance scanner speed - rounds per minutes

Implements argos::CCI_FootBotDistanceScannerActuator.

Definition at line 39 of file footbot_distance_scanner_default_actuator.cpp.

void argos::CFootBotDistanceScannerDefaultActuator::Update ( )
virtual

Updates the state of the entity associated to this actuator.

Implements argos::CSimulatedActuator.

Definition at line 61 of file footbot_distance_scanner_default_actuator.cpp.

Member Data Documentation

const Real argos::CFootBotDistanceScannerDefaultActuator::RPM_TO_RADIANS_PER_SEC = ARGOS_PI / 30.0f
static

Definition at line 29 of file footbot_distance_scanner_default_actuator.h.