Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
mvsim::FrictionBase Class Referenceabstract

#include <FrictionBase.h>

Inheritance diagram for mvsim::FrictionBase:
Inheritance graph
[legend]

Classes

struct  TFrictionInput
 

Public Types

using Ptr = std::shared_ptr< FrictionBase >
 

Public Member Functions

virtual void evaluate_friction (const FrictionBase::TFrictionInput &input, mrpt::math::TPoint2D &out_result_force_local) const =0
 
 FrictionBase (VehicleBase &my_vehicle)
 
void setLogger (const std::weak_ptr< CSVLogger > &logger)
 
virtual ~FrictionBase ()
 

Static Public Member Functions

static FrictionBase::Ptr factory (VehicleBase &parent, const rapidxml::xml_node< char > *xml_node)
 

Protected Attributes

std::weak_ptr< CSVLoggerm_logger
 
VehicleBasem_my_vehicle
 
Worldm_world
 

Detailed Description

Virtual base class for all friction models

Definition at line 20 of file FrictionBase.h.

Member Typedef Documentation

using mvsim::FrictionBase::Ptr = std::shared_ptr<FrictionBase>

Definition at line 23 of file FrictionBase.h.

Constructor & Destructor Documentation

FrictionBase::FrictionBase ( VehicleBase my_vehicle)

Definition at line 37 of file FrictionBase.cpp.

FrictionBase::~FrictionBase ( )
virtual

Definition at line 42 of file FrictionBase.cpp.

Member Function Documentation

virtual void mvsim::FrictionBase::evaluate_friction ( const FrictionBase::TFrictionInput input,
mrpt::math::TPoint2D out_result_force_local 
) const
pure virtual

Evaluates the net force on this wheel (in local coordinates). Refer to the manual for the theorical model.

Implemented in mvsim::WardIagnemmaFriction, and mvsim::DefaultFriction.

FrictionBase::Ptr FrictionBase::factory ( VehicleBase parent,
const rapidxml::xml_node< char > *  xml_node 
)
static

Class factory: Creates a friction object from XML description of type "<friction>...</friction>".

Definition at line 43 of file FrictionBase.cpp.

void FrictionBase::setLogger ( const std::weak_ptr< CSVLogger > &  logger)

Definition at line 65 of file FrictionBase.cpp.

Member Data Documentation

std::weak_ptr<CSVLogger> mvsim::FrictionBase::m_logger
protected

Definition at line 68 of file FrictionBase.h.

VehicleBase& mvsim::FrictionBase::m_my_vehicle
protected

Definition at line 66 of file FrictionBase.h.

World* mvsim::FrictionBase::m_world
protected

Definition at line 65 of file FrictionBase.h.


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


mvsim
Author(s):
autogenerated on Fri May 7 2021 03:05:52