argos::CCI_FootBotDistanceScannerActuator Class Referenceabstract

#include <ci_footbot_distance_scanner_actuator.h>

Inheritance diagram for argos::CCI_FootBotDistanceScannerActuator:
Collaboration diagram for argos::CCI_FootBotDistanceScannerActuator:

Public Member Functions

virtual ~CCI_FootBotDistanceScannerActuator ()
 Destructor. More...
 
virtual void SetAngle (const CRadians &c_angle)=0
 Sets the distance scanner angle The distance scanner can be controller in position or in speed. More...
 
virtual void SetRPM (Real f_rpm)=0
 Sets the distance scanner speed The distance scanner can be controller in position or in speed. More...
 
virtual void Enable ()=0
 Enables the distance scanner. More...
 
virtual void Disable ()=0
 Disables the distance scanner. 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 Reset ()
 Resets the actuator to the state it had just after Init(). More...
 
virtual void Destroy ()
 Destroys the actuator. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

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 55 of file ci_footbot_distance_scanner_actuator.h.

Constructor & Destructor Documentation

◆ ~CCI_FootBotDistanceScannerActuator()

virtual argos::CCI_FootBotDistanceScannerActuator::~CCI_FootBotDistanceScannerActuator ( )
inlinevirtual

Destructor.

Definition at line 62 of file ci_footbot_distance_scanner_actuator.h.

Member Function Documentation

◆ Disable()

virtual void argos::CCI_FootBotDistanceScannerActuator::Disable ( )
pure virtual

Disables the distance scanner.

Implemented in argos::CFootBotDistanceScannerDefaultActuator.

◆ Enable()

virtual void argos::CCI_FootBotDistanceScannerActuator::Enable ( )
pure virtual

Enables the distance scanner.

Implemented in argos::CFootBotDistanceScannerDefaultActuator.

◆ SetAngle()

virtual void argos::CCI_FootBotDistanceScannerActuator::SetAngle ( const CRadians c_angle)
pure 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

Implemented in argos::CFootBotDistanceScannerDefaultActuator.

◆ SetRPM()

virtual void argos::CCI_FootBotDistanceScannerActuator::SetRPM ( Real  f_rpm)
pure 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

Implemented in argos::CFootBotDistanceScannerDefaultActuator.