Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::internal_forces::muscles::FatigueModel Class Referenceabstract

Class Fatigue model of a muscle. More...

#include <FatigueModel.h>

Inheritance diagram for BIORBD_NAMESPACE::internal_forces::muscles::FatigueModel:
BIORBD_NAMESPACE::internal_forces::muscles::HillDeGrooteTypeFatigable BIORBD_NAMESPACE::internal_forces::muscles::HillThelenTypeFatigable

Public Member Functions

 FatigueModel (STATE_FATIGUE_TYPE dynamicFatigueType)
 Contruct a fatigable muscle model.
 FatigueModel (const FatigueModel &other)
 Construct a fatigable muscle model from another muscle.
 FatigueModel (const std::shared_ptr< FatigueModel > other)
 Construct a fatigue model from another fatigue model.
virtual ~FatigueModel ()=0
 Destroy class properly.
void DeepCopy (const FatigueModel &other)
 Deep copy of the fatigue model.
virtual void computeTimeDerivativeState (const StateDynamics &emg)
 Compute the time derivative state.
virtual void setFatigueState (const utils::Scalar &active, const utils::Scalar &fatigued, const utils::Scalar &resting)
 Set the fatigue state.
FatigueState & fatigueState ()
 Return the fatigue state.
const FatigueState & fatigueState () const
 Return the fatigue state.

Protected Attributes

std::shared_ptr< FatigueState > m_fatigueState
 The fatigue state.

Detailed Description

Class Fatigue model of a muscle.

Definition at line 25 of file FatigueModel.h.

Constructor & Destructor Documentation

◆ FatigueModel() [1/3]

internal_forces::muscles::FatigueModel::FatigueModel ( STATE_FATIGUE_TYPE dynamicFatigueType)

Contruct a fatigable muscle model.

Parameters
dynamicFatigueTypeThe type of fatigue of the muscle

Definition at line 10 of file FatigueModel.cpp.

◆ FatigueModel() [2/3]

internal_forces::muscles::FatigueModel::FatigueModel ( const FatigueModel & other)

Construct a fatigable muscle model from another muscle.

Parameters
otherThe other fatigue model

Definition at line 25 of file FatigueModel.cpp.

◆ FatigueModel() [3/3]

internal_forces::muscles::FatigueModel::FatigueModel ( const std::shared_ptr< FatigueModel > other)

Construct a fatigue model from another fatigue model.

Parameters
otherThe other fatigue model

Definition at line 29 of file FatigueModel.cpp.

◆ ~FatigueModel()

internal_forces::muscles::FatigueModel::~FatigueModel ( )
pure virtual

Destroy class properly.

Definition at line 33 of file FatigueModel.cpp.

Member Function Documentation

◆ computeTimeDerivativeState()

void internal_forces::muscles::FatigueModel::computeTimeDerivativeState ( const StateDynamics & emg)
virtual

Compute the time derivative state.

Parameters
emgEMG data

Definition at line 59 of file FatigueModel.cpp.

◆ DeepCopy()

void internal_forces::muscles::FatigueModel::DeepCopy ( const FatigueModel & other)

Deep copy of the fatigue model.

Parameters
otherThe other fatigue model to copy

Definition at line 35 of file FatigueModel.cpp.

◆ fatigueState() [1/2]

internal_forces::muscles::FatigueState & internal_forces::muscles::FatigueModel::fatigueState ( )

Return the fatigue state.

Returns
The fatigue state

Definition at line 50 of file FatigueModel.cpp.

◆ fatigueState() [2/2]

const internal_forces::muscles::FatigueState & internal_forces::muscles::FatigueModel::fatigueState ( ) const

Return the fatigue state.

Returns
The fatigue state

Definition at line 55 of file FatigueModel.cpp.

◆ setFatigueState()

void internal_forces::muscles::FatigueModel::setFatigueState ( const utils::Scalar & active,
const utils::Scalar & fatigued,
const utils::Scalar & resting )
virtual

Set the fatigue state.

Parameters
active
fatigued
resting

Definition at line 41 of file FatigueModel.cpp.

Member Data Documentation

◆ m_fatigueState

std::shared_ptr<FatigueState> BIORBD_NAMESPACE::internal_forces::muscles::FatigueModel::m_fatigueState
protected

The fatigue state.

Definition at line 86 of file FatigueModel.h.


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