LocalGuidance
A library that generates velocity references to follow a path.
robot_utils::FunctionGeneratorBase Class Referenceabstract

#include <FunctionGeneratorBase.hpp>

Inheritance diagram for robot_utils::FunctionGeneratorBase:
Inheritance graph

Public Member Functions

 FunctionGeneratorBase ()
 
virtual ~FunctionGeneratorBase ()
 
virtual double getUpAndDownSweepValue (double time)=0
 
virtual double getUpSweepValue (double time)=0
 
virtual void setParamAmplitude (double paramAmplitude)
 
virtual void setParamMinFrequencyHz (double minFreq)
 
virtual void setParamMaxFrequencyHz (double maxFreq)
 
virtual void setParamTimeInteval (double timeInterval)
 
virtual void setCurrentFrequencyHz (double currentFreq)
 
virtual void setComputedTimeInteval (double computedTimeInterval)
 
virtual const double getParamAmplitude () const
 
virtual const double getParamMinFrequencyHz () const
 
virtual const double getParamMaxFrequencyHz () const
 
virtual const double getParamTimeInteval () const
 
virtual const double getCurrentFrequencyHz () const
 
virtual const double getComputedTimeInteval () const
 
virtual double & getCurrentFrequencyHz ()
 

Protected Attributes

double paramAmplitude_
 amplitude of sine More...
 
double paramMinFrequencyHz_
 minimum frequency [Hz] More...
 
double paramMaxFrequencyHz_
 maximum frequency [Hz] More...
 
double paramTimeInteval_
 time interval of the sweep (estimated time interval for up and down sweep) More...
 
double currentFrequencyHz_
 current frequency for logging More...
 
double computedTimeInteval_
 exact time interval for up and down sweep More...
 

Constructor & Destructor Documentation

◆ FunctionGeneratorBase()

robot_utils::FunctionGeneratorBase::FunctionGeneratorBase ( )

◆ ~FunctionGeneratorBase()

virtual robot_utils::FunctionGeneratorBase::~FunctionGeneratorBase ( )
virtual

Member Function Documentation

◆ getComputedTimeInteval()

virtual const double robot_utils::FunctionGeneratorBase::getComputedTimeInteval ( ) const
virtual

◆ getCurrentFrequencyHz() [1/2]

virtual const double robot_utils::FunctionGeneratorBase::getCurrentFrequencyHz ( ) const
virtual

◆ getCurrentFrequencyHz() [2/2]

virtual double& robot_utils::FunctionGeneratorBase::getCurrentFrequencyHz ( )
virtual

◆ getParamAmplitude()

virtual const double robot_utils::FunctionGeneratorBase::getParamAmplitude ( ) const
virtual

◆ getParamMaxFrequencyHz()

virtual const double robot_utils::FunctionGeneratorBase::getParamMaxFrequencyHz ( ) const
virtual

◆ getParamMinFrequencyHz()

virtual const double robot_utils::FunctionGeneratorBase::getParamMinFrequencyHz ( ) const
virtual

◆ getParamTimeInteval()

virtual const double robot_utils::FunctionGeneratorBase::getParamTimeInteval ( ) const
virtual

◆ getUpAndDownSweepValue()

virtual double robot_utils::FunctionGeneratorBase::getUpAndDownSweepValue ( double  time)
pure virtual

Up and Down Sweep Function

Parameters
timetime [s]
Returns
value

Implemented in robot_utils::FctLogChirp, and robot_utils::FctLinChirp.

◆ getUpSweepValue()

virtual double robot_utils::FunctionGeneratorBase::getUpSweepValue ( double  time)
pure virtual

Up Sweep Function

Parameters
timetime [s]
Returns
value

Implemented in robot_utils::FctLogChirp, and robot_utils::FctLinChirp.

◆ setComputedTimeInteval()

virtual void robot_utils::FunctionGeneratorBase::setComputedTimeInteval ( double  computedTimeInterval)
virtual

◆ setCurrentFrequencyHz()

virtual void robot_utils::FunctionGeneratorBase::setCurrentFrequencyHz ( double  currentFreq)
virtual

◆ setParamAmplitude()

virtual void robot_utils::FunctionGeneratorBase::setParamAmplitude ( double  paramAmplitude)
virtual

◆ setParamMaxFrequencyHz()

virtual void robot_utils::FunctionGeneratorBase::setParamMaxFrequencyHz ( double  maxFreq)
virtual

◆ setParamMinFrequencyHz()

virtual void robot_utils::FunctionGeneratorBase::setParamMinFrequencyHz ( double  minFreq)
virtual

◆ setParamTimeInteval()

virtual void robot_utils::FunctionGeneratorBase::setParamTimeInteval ( double  timeInterval)
virtual

Member Data Documentation

◆ computedTimeInteval_

double robot_utils::FunctionGeneratorBase::computedTimeInteval_
protected

exact time interval for up and down sweep

◆ currentFrequencyHz_

double robot_utils::FunctionGeneratorBase::currentFrequencyHz_
protected

current frequency for logging

◆ paramAmplitude_

double robot_utils::FunctionGeneratorBase::paramAmplitude_
protected

amplitude of sine

◆ paramMaxFrequencyHz_

double robot_utils::FunctionGeneratorBase::paramMaxFrequencyHz_
protected

maximum frequency [Hz]

◆ paramMinFrequencyHz_

double robot_utils::FunctionGeneratorBase::paramMinFrequencyHz_
protected

minimum frequency [Hz]

◆ paramTimeInteval_

double robot_utils::FunctionGeneratorBase::paramTimeInteval_
protected

time interval of the sweep (estimated time interval for up and down sweep)


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