Public Member Functions | Protected Member Functions | List of all members
gazebo::ConversionFunction Class Referenceabstract

Abstact base class for a thruster conversion function. More...

#include <ThrusterConversionFcn.hh>

Inheritance diagram for gazebo::ConversionFunction:
Inheritance graph
[legend]

Public Member Functions

virtual double convert (double _cmd)=0
 Convert thruster state (e.g. angular velocity) to thrust force. More...
 
virtual bool GetParam (std::string _tag, double &_output)=0
 Return paramater in vector form for the given tag. More...
 
virtual std::map< double, double > GetTable ()
 Return input and output vectors of the lookup table. More...
 
virtual std::string GetType ()=0
 Return (derived) type of conversion function. More...
 
virtual ~ConversionFunction ()
 Destructor. More...
 

Protected Member Functions

 ConversionFunction ()
 Protected constructor: Use the factory instead. More...
 

Detailed Description

Abstact base class for a thruster conversion function.

Definition at line 31 of file ThrusterConversionFcn.hh.

Constructor & Destructor Documentation

gazebo::ConversionFunction::ConversionFunction ( )
inlineprotected

Protected constructor: Use the factory instead.

Definition at line 34 of file ThrusterConversionFcn.hh.

virtual gazebo::ConversionFunction::~ConversionFunction ( )
inlinevirtual

Destructor.

Definition at line 37 of file ThrusterConversionFcn.hh.

Member Function Documentation

virtual double gazebo::ConversionFunction::convert ( double  _cmd)
pure virtual

Convert thruster state (e.g. angular velocity) to thrust force.

Implemented in gazebo::ConversionFunctionLinearInterp, gazebo::ConversionFunctionBessa, and gazebo::ConversionFunctionBasic.

virtual bool gazebo::ConversionFunction::GetParam ( std::string  _tag,
double &  _output 
)
pure virtual

Return paramater in vector form for the given tag.

Implemented in gazebo::ConversionFunctionLinearInterp, gazebo::ConversionFunctionBessa, and gazebo::ConversionFunctionBasic.

virtual std::map<double, double> gazebo::ConversionFunction::GetTable ( )
inlinevirtual

Return input and output vectors of the lookup table.

Reimplemented in gazebo::ConversionFunctionLinearInterp.

Definition at line 47 of file ThrusterConversionFcn.hh.

virtual std::string gazebo::ConversionFunction::GetType ( )
pure virtual

Return (derived) type of conversion function.

Implemented in gazebo::ConversionFunctionLinearInterp, gazebo::ConversionFunctionBessa, and gazebo::ConversionFunctionBasic.


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


uuv_gazebo_plugins
Author(s): Musa Morena Marcusso Manhaes , Sebastian Scherer , Luiz Ricardo Douat
autogenerated on Mon Jul 1 2019 19:39:12