Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gazebo::LiftDrag Class Referenceabstract

Abstract base class for Lift&Drag models. More...

#include <LiftDragModel.hh>

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

Public Member Functions

virtual ignition::math::Vector3d compute (const ignition::math::Vector3d &_velL)=0
 Compute the lift and drag force. More...
 
virtual std::map< std::string, double > GetListParams ()=0
 Return list of all parameters. More...
 
virtual bool GetParam (std::string _tag, double &_output)=0
 Return paramater in vector form for the given tag. More...
 
virtual std::string GetType ()=0
 Return (derived) type of lift&drag model. More...
 
virtual ~LiftDrag ()
 Destructor. More...
 

Static Public Member Functions

static bool CheckForElement (sdf::ElementPtr _sdf, const std::string &element)
 Check for element. Complain and return 0 if it is missing. More...
 

Protected Member Functions

 LiftDrag ()
 Protected constructor: Use the factory for object creation. More...
 

Protected Attributes

double prevTime
 Time of last state update. More...
 
double state
 Latest state. More...
 

Detailed Description

Abstract base class for Lift&Drag models.

Definition at line 32 of file LiftDragModel.hh.

Constructor & Destructor Documentation

gazebo::LiftDrag::LiftDrag ( )
inlineprotected

Protected constructor: Use the factory for object creation.

Definition at line 35 of file LiftDragModel.hh.

virtual gazebo::LiftDrag::~LiftDrag ( )
inlinevirtual

Destructor.

Definition at line 42 of file LiftDragModel.hh.

Member Function Documentation

bool gazebo::LiftDrag::CheckForElement ( sdf::ElementPtr  _sdf,
const std::string &  element 
)
static

Check for element. Complain and return 0 if it is missing.

Definition at line 23 of file LiftDragModel.cc.

virtual ignition::math::Vector3d gazebo::LiftDrag::compute ( const ignition::math::Vector3d &  _velL)
pure virtual

Compute the lift and drag force.

Implemented in gazebo::LiftDragTwoLines, and gazebo::LiftDragQuadratic.

virtual std::map<std::string, double> gazebo::LiftDrag::GetListParams ( )
pure virtual

Return list of all parameters.

Implemented in gazebo::LiftDragTwoLines, and gazebo::LiftDragQuadratic.

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

Return paramater in vector form for the given tag.

Implemented in gazebo::LiftDragTwoLines, and gazebo::LiftDragQuadratic.

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

Return (derived) type of lift&drag model.

Implemented in gazebo::LiftDragTwoLines, and gazebo::LiftDragQuadratic.

Member Data Documentation

double gazebo::LiftDrag::prevTime
protected

Time of last state update.

Definition at line 59 of file LiftDragModel.hh.

double gazebo::LiftDrag::state
protected

Latest state.

Definition at line 62 of file LiftDragModel.hh.


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


uuv_gazebo_plugins
Author(s): Musa Morena Marcusso Manhaes , Sebastian Scherer , Luiz Ricardo Douat
autogenerated on Thu Jun 18 2020 03:28:24