RobWorkProject
Classes | Public Member Functions | List of all members
RWPERestitutionModel Class Referenceabstract

A restitution model calculates restitution coefficients based on the relative incomming velocity. More...

#include <RWPERestitutionModel.hpp>

Inherited by RWPERestitutionModelNewton.

Classes

class  Factory
 A factory for a RWPERestitutionModel. This factory also defines an ExtensionPoint. More...
 
struct  Values
 The possible restitution values. More...
 

Public Member Functions

 RWPERestitutionModel ()
 Constructor.
 
virtual ~RWPERestitutionModel ()
 Destructor.
 
virtual const RWPERestitutionModelwithProperties (const rw::common::PropertyMap &map) const =0
 Get a model with the given properties. More...
 
virtual Values getRestitution (const RWPEContact &contact, const RWPEIslandState &islandState, const rw::kinematics::State &rwstate) const =0
 Get the restitution coefficients. More...
 

Detailed Description

A restitution model calculates restitution coefficients based on the relative incomming velocity.

Member Function Documentation

◆ getRestitution()

virtual Values getRestitution ( const RWPEContact contact,
const RWPEIslandState islandState,
const rw::kinematics::State rwstate 
) const
pure virtual

Get the restitution coefficients.

Parameters
contact[in] the contact to find coefficient for.
islandState[in] the current state of the system.
rwstate[in] the current state of the system.
Returns
the Values.

Implemented in RWPERestitutionModelNewton.

◆ withProperties()

virtual const RWPERestitutionModel* withProperties ( const rw::common::PropertyMap map) const
pure virtual

Get a model with the given properties.

Parameters
map[in] a map of properties with the required parameters for the model.
Returns
a restitution model with the given properties (can return NULL if properties are not as expected).

Implemented in RWPERestitutionModelNewton.


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