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

Implementation of Xia (https://www.sciencedirect.com/science/article/pii/S0021929008003692) dynamic fatigue model. More...

#include <FatigueDynamicStateXia.h>

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

Public Member Functions

 FatigueDynamicStateXia (const utils::Scalar &active=1, const utils::Scalar &fatigued=0, const utils::Scalar &resting=0)
 Construct FatigueDynamicStateXia.
 FatigueDynamicStateXia (const std::shared_ptr< FatigueState > other)
 Contruct FatigueDynamicsStateXia from another fatigue state.
FatigueDynamicStateXia DeepCopy () const
 Deep copy of the fatigue dynamic state xia.
void DeepCopy (const FatigueDynamicStateXia &other)
 Deep copy of a fatigue dynamic state xia.
virtual void timeDerivativeState (const StateDynamics &emg, const Characteristics &characteristics)
 Time derivative state of the current states.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState
 FatigueDynamicState (const utils::Scalar &active=0, const utils::Scalar &fatigued=0, const utils::Scalar &resting=1)
 Construct the fatigue dynamic state.
 FatigueDynamicState (const std::shared_ptr< FatigueState > other)
 Construct the fatigue dynamic state from other state.
void DeepCopy (const FatigueDynamicState &other)
 Deep copy of a fatigue dynamic state.
const utils::Scalar & activeFibersDot () const
 Return the active fibers derivative.
const utils::Scalar & fatiguedFibersDot () const
 Return the fatigued fibers derivative.
const utils::Scalar & restingFibersDot () const
 Return the resting fibers derivative.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::muscles::FatigueState
 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 type of fatigue dynamic state xia.

Additional Inherited Members

Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState
std::shared_ptr< utils::Scalar > m_activeFibersDot
 The active fibers derivative.
std::shared_ptr< utils::Scalar > m_fatiguedFibersDot
 The fatigued fibers derivative.
std::shared_ptr< utils::Scalar > m_restingFibersDot
 The resting fibers derivative.
Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::muscles::FatigueState
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

Implementation of Xia (https://www.sciencedirect.com/science/article/pii/S0021929008003692) dynamic fatigue model.

Definition at line 17 of file FatigueDynamicStateXia.h.

Constructor & Destructor Documentation

◆ FatigueDynamicStateXia() [1/2]

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

Construct FatigueDynamicStateXia.

Parameters
activeActive muscle
fatiguedFatigued muscle
restingResting muscle

Definition at line 13 of file FatigueDynamicStateXia.cpp.

◆ FatigueDynamicStateXia() [2/2]

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

Contruct FatigueDynamicsStateXia from another fatigue state.

Parameters
otherThe other fatigue state

Definition at line 21 of file FatigueDynamicStateXia.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

internal_forces::muscles::FatigueDynamicStateXia internal_forces::muscles::FatigueDynamicStateXia::DeepCopy ( ) const

Deep copy of the fatigue dynamic state xia.

Returns
Deep copy of fatigue dynamic state xia

Definition at line 26 of file FatigueDynamicStateXia.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of a fatigue dynamic state xia.

Parameters
otherThe fatigue dynamic state xia to copy

Definition at line 32 of file FatigueDynamicStateXia.cpp.

◆ setType()

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

Set type of fatigue dynamic state xia.

Reimplemented from BIORBD_NAMESPACE::internal_forces::muscles::FatigueState.

Definition at line 78 of file FatigueDynamicStateXia.cpp.

◆ timeDerivativeState()

void internal_forces::muscles::FatigueDynamicStateXia::timeDerivativeState ( const StateDynamics & emg,
const Characteristics & characteristics )
virtual

Time derivative state of the current states.

Parameters
emgThe EMG data
characteristicsThe muscle characteristics

Implements BIORBD_NAMESPACE::internal_forces::muscles::FatigueDynamicState.

Definition at line 37 of file FatigueDynamicStateXia.cpp.


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