Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::internal_forces::muscles::FatigueState Class Reference

Base class for Fatigue states models. More...

#include <FatigueState.h>

Inheritance diagram for BIORBD_NAMESPACE::internal_forces::muscles::FatigueState:
BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicStateXia

Public Member Functions

 FatigueState (const utils::Scalar &active=1, const utils::Scalar &fatigued=0, const utils::Scalar &resting=0)
 Construct fatigue state.
 FatigueState (const FatigueState &other)
 Construct fatigue state from another fatigue state.
 FatigueState (const std::shared_ptr< FatigueState > other)
 Construct fatigue state from another fatigue state.
virtual ~FatigueState ()
 Destroy class properly.
FatigueState DeepCopy () const
 Deep copy of the fatigue state.
void DeepCopy (const FatigueState &other)
 Deep copy of fatigue state in another fatigue state.
virtual void setState (utils::Scalar active, utils::Scalar fatigued, utils::Scalar resting, bool turnOffWarnings=false)
 Safe set of the state (ensure that sum of all activation is 1).
const utils::Scalar & activeFibers () const
 Return the propotion of active muscle fibers.
const utils::Scalar & fatiguedFibers () const
 Return the propotion of fatigued muscle fibers.
const utils::Scalar & restingFibers () const
 Return the propotion of resting muscle fibers.
STATE_FATIGUE_TYPE getType () const
 Return the type of muscle fatigue model.

Protected Member Functions

virtual void setType ()
 Set the type.

Protected Attributes

std::shared_ptr< utils::Scalar > m_activeFibers
 Proportion of active muscle fibers.
std::shared_ptr< utils::Scalar > m_fatiguedFibers
 Proportion of fatigued muscle fibers.
std::shared_ptr< utils::Scalar > m_restingFibers
 Proportion of resting muscle fibers.
std::shared_ptr< STATE_FATIGUE_TYPE > m_type
 Type of the muscle fatigue model.

Detailed Description

Base class for Fatigue states models.

Definition at line 18 of file FatigueState.h.

Constructor & Destructor Documentation

◆ FatigueState() [1/3]

internal_forces::muscles::FatigueState::FatigueState ( const utils::Scalar & active = 1,
const utils::Scalar & fatigued = 0,
const utils::Scalar & resting = 0 )

Construct fatigue state.

Parameters
activeActive muscle
fatiguedMuscle fatigue
restingResting muscle

Definition at line 22 of file FatigueState.cpp.

◆ FatigueState() [2/3]

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

Construct fatigue state from another fatigue state.

Parameters
otherThe other fatigure state

Definition at line 33 of file FatigueState.cpp.

◆ FatigueState() [3/3]

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

Construct fatigue state from another fatigue state.

Parameters
otherThe other fatigure state

Definition at line 40 of file FatigueState.cpp.

◆ ~FatigueState()

internal_forces::muscles::FatigueState::~FatigueState ( )
virtual

Destroy class properly.

Definition at line 47 of file FatigueState.cpp.

Member Function Documentation

◆ activeFibers()

const utils::Scalar & internal_forces::muscles::FatigueState::activeFibers ( ) const

Return the propotion of active muscle fibers.

Returns
The propotion of active muscle fibers

Definition at line 139 of file FatigueState.cpp.

◆ DeepCopy() [1/2]

internal_forces::muscles::FatigueState internal_forces::muscles::FatigueState::DeepCopy ( ) const

Deep copy of the fatigue state.

Returns
A deep copy of the fatigue state

Definition at line 50 of file FatigueState.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of fatigue state in another fatigue state.

Parameters
otherThe fatigue state to copy

Definition at line 56 of file FatigueState.cpp.

◆ fatiguedFibers()

const utils::Scalar & internal_forces::muscles::FatigueState::fatiguedFibers ( ) const

Return the propotion of fatigued muscle fibers.

Returns
The propotion of fatigued muscle fibers

Definition at line 144 of file FatigueState.cpp.

◆ getType()

internal_forces::muscles::STATE_FATIGUE_TYPE internal_forces::muscles::FatigueState::getType ( ) const

Return the type of muscle fatigue model.

Returns
The type of muscle fatigue model

Definition at line 155 of file FatigueState.cpp.

◆ restingFibers()

const utils::Scalar & internal_forces::muscles::FatigueState::restingFibers ( ) const

Return the propotion of resting muscle fibers.

Returns
The propotion of resting muscle fibers

Definition at line 149 of file FatigueState.cpp.

◆ setState()

void internal_forces::muscles::FatigueState::setState ( utils::Scalar active,
utils::Scalar fatigued,
utils::Scalar resting,
bool turnOffWarnings = false )
virtual

Safe set of the state (ensure that sum of all activation is 1).

Parameters
activeProportion of the activated fibers in the muscle
fatiguedProportion of the fatigued fibers in the muscle
restingProportion of the resting fibers in the muscle
turnOffWarningsIf the warnings should be OFF or ON.

Definition at line 65 of file FatigueState.cpp.

◆ setType()

void internal_forces::muscles::FatigueState::setType ( )
protectedvirtual

Set the type.

Reimplemented in BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicStateXia.

Definition at line 159 of file FatigueState.cpp.

Member Data Documentation

◆ m_activeFibers

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::FatigueState::m_activeFibers
protected

Proportion of active muscle fibers.

Definition at line 101 of file FatigueState.h.

◆ m_fatiguedFibers

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::FatigueState::m_fatiguedFibers
protected

Proportion of fatigued muscle fibers.

Definition at line 103 of file FatigueState.h.

◆ m_restingFibers

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::muscles::FatigueState::m_restingFibers
protected

Proportion of resting muscle fibers.

Definition at line 105 of file FatigueState.h.

◆ m_type

std::shared_ptr<STATE_FATIGUE_TYPE> BIORBD_NAMESPACE::internal_forces::muscles::FatigueState::m_type
protected

Type of the muscle fatigue model.

Definition at line 112 of file FatigueState.h.


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