biorbd::muscles::FatigueParameters Class Reference

Class FatigueParameters that holds the muscle fatigue parameters. More...

#include <FatigueParameters.h>

Public Member Functions
	FatigueParameters (const biorbd::utils::Scalar &fatigueRate=0, const biorbd::utils::Scalar &recoveryRate=0, const biorbd::utils::Scalar &developFactor=0, const biorbd::utils::Scalar &recoveryFactor=0)
	Construct the fatigue parameters. More...
biorbd::muscles::FatigueParameters	DeepCopy () const
	Deep copy of the fatigue parameters. More...
void	DeepCopy (const biorbd::muscles::FatigueParameters &other)
	Deep copy of fatigue parameters into another FatigueParameters. More...
void	setFatigueRate (const biorbd::utils::Scalar &fatigueRate)
	Set the fatigue rate. More...
const biorbd::utils::Scalar &	fatigueRate () const
	Return the fatigue rate. More...
void	setRecoveryRate (const biorbd::utils::Scalar &recoveryRate)
	Set the recovery rate. More...
const biorbd::utils::Scalar &	recoveryRate () const
	Return the recovery rate. More...
void	setDevelopFactor (const biorbd::utils::Scalar &developFactor)
	Set the develop factor. More...
const biorbd::utils::Scalar &	developFactor () const
	Return the develop factor. More...
void	setRecoveryFactor (const biorbd::utils::Scalar &recoveryFactor)
	Set the recovery factor. More...
const biorbd::utils::Scalar &	recoveryFactor () const
	Return the recovery factor. More...

Protected Attributes
std::shared_ptr< biorbd::utils::Scalar >	m_fatigueRate
	The fatigue rate.
std::shared_ptr< biorbd::utils::Scalar >	m_recoveryRate
	The recovery rate.
std::shared_ptr< biorbd::utils::Scalar >	m_developFactor
	The develop factor.
std::shared_ptr< biorbd::utils::Scalar >	m_recoveryFactor
	The recovery factor.

Detailed Description

Class FatigueParameters that holds the muscle fatigue parameters.

Definition at line 15 of file FatigueParameters.h.

Constructor & Destructor Documentation

FatigueParameters()

biorbd::muscles::FatigueParameters::FatigueParameters	(	const biorbd::utils::Scalar &	fatigueRate = 0,
		const biorbd::utils::Scalar &	recoveryRate = 0,
		const biorbd::utils::Scalar &	developFactor = 0,
		const biorbd::utils::Scalar &	recoveryFactor = 0
	)

Construct the fatigue parameters.

Parameters

fatigueRate	The fatigue rate
recoveryRate	The recovery rate
developFactor	The develop factor
recoveryFactor	The recovery factor

Definition at line 4 of file FatigueParameters.cpp.

Member Function Documentation

DeepCopy() [1/2]

biorbd::muscles::FatigueParameters biorbd::muscles::FatigueParameters::DeepCopy

(

)

const

Deep copy of the fatigue parameters.

Returns

Copy of the fatigue parameters

Definition at line 17 of file FatigueParameters.cpp.

DeepCopy() [2/2]

void biorbd::muscles::FatigueParameters::DeepCopy

(

const biorbd::muscles::FatigueParameters &

other

)

Deep copy of fatigue parameters into another FatigueParameters.

Parameters

other

The fatigue parameters to copy

Definition at line 24 of file FatigueParameters.cpp.

developFactor()

const biorbd::utils::Scalar & biorbd::muscles::FatigueParameters::developFactor

(

)

const

Return the develop factor.

Returns

The develop factor

Definition at line 57 of file FatigueParameters.cpp.

fatigueRate()

const biorbd::utils::Scalar & biorbd::muscles::FatigueParameters::fatigueRate

(

)

const

Return the fatigue rate.

Returns

The fatigue rate

Definition at line 37 of file FatigueParameters.cpp.

recoveryFactor()

const biorbd::utils::Scalar & biorbd::muscles::FatigueParameters::recoveryFactor

(

)

const

Return the recovery factor.

Returns

The recovery factor

Definition at line 67 of file FatigueParameters.cpp.

recoveryRate()

const biorbd::utils::Scalar & biorbd::muscles::FatigueParameters::recoveryRate

(

)

const

Return the recovery rate.

Returns

The recovery rate

Definition at line 47 of file FatigueParameters.cpp.

setDevelopFactor()

void biorbd::muscles::FatigueParameters::setDevelopFactor

(

const biorbd::utils::Scalar &

developFactor

)

Set the develop factor.

Parameters

developFactor

The develop factor

Definition at line 52 of file FatigueParameters.cpp.

setFatigueRate()

void biorbd::muscles::FatigueParameters::setFatigueRate

(

const biorbd::utils::Scalar &

fatigueRate

)

Set the fatigue rate.

Parameters

fatigueRate

The fatigue rate

Definition at line 32 of file FatigueParameters.cpp.

setRecoveryFactor()

void biorbd::muscles::FatigueParameters::setRecoveryFactor

(

const biorbd::utils::Scalar &

recoveryFactor

)

Set the recovery factor.

Parameters

recoveryFactor

The recovery factor

Definition at line 62 of file FatigueParameters.cpp.

setRecoveryRate()

void biorbd::muscles::FatigueParameters::setRecoveryRate

(

const biorbd::utils::Scalar &

recoveryRate

)

Set the recovery rate.

Parameters

recoveryRate

The recovery rate

Definition at line 42 of file FatigueParameters.cpp.

---

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

• FatigueParameters.h
• FatigueParameters.cpp