Fawkes API  Fawkes Development Version
fawkes::BaseMotorInstruct Class Referenceabstract

#include <>>

Inheritance diagram for fawkes::BaseMotorInstruct:

Public Member Functions

 BaseMotorInstruct (MotorInterface *motor, float frequency, Logger *logger, Configuration *config)
 Constructor. More...
 
virtual ~BaseMotorInstruct ()
 Desctructor. More...
 
void drive (float trans_x, float trans_y, float rot)
 Try to realize the proposed values with respect to the maximum allowed values. More...
 
void stop ()
 Executes a soft stop with respect to calculate_translation and calculate_rotation. More...
 

Protected Attributes

Loggerlogger_
 The fawkes logger. More...
 
Configurationconfig_
 The fawkse config. More...
 
float trans_acc_
 Translation acceleration. More...
 
float trans_dec_
 Translation deceleration. More...
 
float rot_acc_
 Rotation acceleration. More...
 
float rot_dec_
 Rotation deceleration. More...
 

Detailed Description

The Basic of a Motorinstructor.

Definition at line 48 of file base_motor_instruct.h.

Constructor & Destructor Documentation

◆ BaseMotorInstruct()

fawkes::BaseMotorInstruct::BaseMotorInstruct ( MotorInterface motor,
float  frequency,
Logger logger,
Configuration config 
)
inline

Constructor.

Initializes all constants and the local pointers.

Parameters
motorThe MotorInterface with all the motor information
frequencyThe frequency of the colli (should become deprecated!)
loggerThe fawkes logger
configThe fawkes configuration

Definition at line 105 of file base_motor_instruct.h.

◆ ~BaseMotorInstruct()

Member Function Documentation

◆ drive()

void fawkes::BaseMotorInstruct::drive ( float  trans_x,
float  trans_y,
float  rot 
)
inline

Try to realize the proposed values with respect to the maximum allowed values.

Try to realize the proposed values with respect to the physical constraints of the robot.

Parameters
trans_xthe proposed x translation velocity
trans_ythe proposed y translation velocity
rotthe proposed rotation velocity

Definition at line 179 of file base_motor_instruct.h.

◆ stop()

void fawkes::BaseMotorInstruct::stop ( )
inline

Executes a soft stop with respect to calculate_translation and calculate_rotation.

Executes a soft stop with respect to calculate_translation and calculate_rotation if it is called several times.

Definition at line 224 of file base_motor_instruct.h.

Referenced by ColliThread::loop().

Member Data Documentation

◆ config_

Configuration* fawkes::BaseMotorInstruct::config_
protected

The fawkse config.

Definition at line 62 of file base_motor_instruct.h.

◆ logger_

Logger* fawkes::BaseMotorInstruct::logger_
protected

The fawkes logger.

Definition at line 61 of file base_motor_instruct.h.

Referenced by fawkes::EmergencyMotorInstruct::EmergencyMotorInstruct(), and ~BaseMotorInstruct().

◆ rot_acc_

float fawkes::BaseMotorInstruct::rot_acc_
protected

Rotation acceleration.

Definition at line 66 of file base_motor_instruct.h.

◆ rot_dec_

float fawkes::BaseMotorInstruct::rot_dec_
protected

Rotation deceleration.

Definition at line 67 of file base_motor_instruct.h.

◆ trans_acc_

float fawkes::BaseMotorInstruct::trans_acc_
protected

Translation acceleration.

Definition at line 64 of file base_motor_instruct.h.

◆ trans_dec_

float fawkes::BaseMotorInstruct::trans_dec_
protected

Translation deceleration.

Definition at line 65 of file base_motor_instruct.h.


The documentation for this class was generated from the following file: