EMG with the capability to compute the time derivative. More...

#include <StateDynamicsDeGroote.h>

Inheritance diagram for BIORBD_NAMESPACE::internal_forces::muscles::StateDynamicsDeGroote:

Public Member Functions
	StateDynamicsDeGroote (const utils::Scalar &excitation=0, const utils::Scalar &activation=0)
	Construct the state dynamics.
	StateDynamicsDeGroote (const StateDynamicsDeGroote &other)
	Construct a state dynamics from another state dynamics.
StateDynamicsDeGroote	DeepCopy () const
	Deep copy of state dynamics.
void	DeepCopy (const StateDynamicsDeGroote &other)
	Deep copy of state dynamics into another state dynamics.
virtual const utils::Scalar &	timeDerivativeActivation (const Characteristics &characteristics, bool alreadyNormalized=false)
	Compute and return the activation time derivative.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::muscles::StateDynamics
	StateDynamics (const utils::Scalar &excitation=0, const utils::Scalar &activation=0)
	Construct the state dynamics.
	StateDynamics (const State &other)
	Construct a state dynamics from another state dynamics.
virtual	~StateDynamics ()
	Destroy class properly.
StateDynamics	DeepCopy () const
	Deep copy of state dynamics.
void	DeepCopy (const StateDynamics &other)
	Deep copy of state dynamics into another state dynamics.
virtual void	setExcitation (const utils::Scalar &val, bool turnOffWarnings=false)
	Set the muscle excitation.
const utils::Scalar &	previousExcitation () const
	Return the previous activation.
virtual void	setActivation (const utils::Scalar &val, bool turnOffWarnings=false)
	Set the muscle activation.
const utils::Scalar &	previousActivation () const
	Return the previous activation.
virtual const utils::Scalar &	timeDerivativeActivation (const utils::Scalar &excitation, const utils::Scalar &activation, const Characteristics &characteristics, bool alreadyNormalized=false)
	Compute and return the activation time derivative from the excitation and activation.
virtual const utils::Scalar &	timeDerivativeActivation (const State &emg, const Characteristics &characteristics, bool alreadyNormalized=false)
	Compute and return the activation time derivative.
virtual const utils::Scalar &	timeDerivativeActivation ()
	Return the previously computed activation time derivative.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::muscles::State
	State (const utils::Scalar &excitation=0, const utils::Scalar &activation=0)
	Construct a state.
	State (const State &other)
	Construct a muscle state from another state.
virtual	~State ()
	Destroy class properly.
State	DeepCopy () const
	Deep copy of state.
void	DeepCopy (const State &other)
	Deep copy of state into another state.
const utils::Scalar &	excitation () const
	Return the muscle excitation.
const utils::Scalar &	normalizeExcitation (const State &emgMax, bool turnOffWarnings=false)
	Compute and return the normalized excitation.
void	setExcitationNorm (const utils::Scalar &val)
	Force set the normalized excitation.
const utils::Scalar &	excitationNorm () const
	Return the previously normalized excitation.
const utils::Scalar &	activation () const
	Return the muscle activation.
STATE_TYPE	type () const
	Return the state type.

Protected Member Functions
virtual void	setType ()
	Set the type to simple_state.

Additional Inherited Members
Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::muscles::StateDynamics
std::shared_ptr< utils::Scalar >	m_previousExcitation
	The previous excitation.
std::shared_ptr< utils::Scalar >	m_previousActivation
	The previous activation.
std::shared_ptr< utils::Scalar >	m_activationDot
	The activation velocity.
Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::muscles::State
std::shared_ptr< STATE_TYPE >	m_stateType
	The state type.
std::shared_ptr< utils::Scalar >	m_excitation
	The muscle excitation.
std::shared_ptr< utils::Scalar >	m_excitationNorm
	The normalized excitation.
std::shared_ptr< utils::Scalar >	m_activation
	The muscle activation.

Detailed Description

EMG with the capability to compute the time derivative.

Definition at line 14 of file StateDynamicsDeGroote.h.

Constructor & Destructor Documentation

◆ StateDynamicsDeGroote() [1/2]

internal_forces::muscles::StateDynamicsDeGroote::StateDynamicsDeGroote	(	const utils::Scalar &	excitation = 0,
		const utils::Scalar &	activation = 0 )

Construct the state dynamics.

Parameters

excitation	The muscle excitation
activation	The muscle activation

Definition at line 12 of file StateDynamicsDeGroote.cpp.

◆ StateDynamicsDeGroote() [2/2]

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

Construct a state dynamics from another state dynamics.

Parameters

other The other state dynamics

Definition at line 19 of file StateDynamicsDeGroote.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

internal_forces::muscles::StateDynamicsDeGroote internal_forces::muscles::StateDynamicsDeGroote::DeepCopy ( ) const

Deep copy of state dynamics.

Returns: A deep copy of state dynamics

Definition at line 24 of file StateDynamicsDeGroote.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of state dynamics into another state dynamics.

Parameters

other The state dynamics to copy

Definition at line 30 of file StateDynamicsDeGroote.cpp.

◆ setType()

void internal_forces::muscles::StateDynamicsDeGroote::setType ( )

protectedvirtual

Set the type to simple_state.

Reimplemented from BIORBD_NAMESPACE::internal_forces::muscles::StateDynamics.

Definition at line 60 of file StateDynamicsDeGroote.cpp.

◆ timeDerivativeActivation()

const utils::Scalar & internal_forces::muscles::StateDynamicsDeGroote::timeDerivativeActivation	(	const Characteristics &	characteristics,
		bool	alreadyNormalized = false )

virtual

Compute and return the activation time derivative.

Parameters

characteristics	The muscle characteristics
alreadyNormalized	If already normalized

Returns: The activation time derivative

Reimplemented from BIORBD_NAMESPACE::internal_forces::muscles::StateDynamics.

Definition at line 36 of file StateDynamicsDeGroote.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StateDynamicsDeGroote() [1/2]

◆ StateDynamicsDeGroote() [2/2]

Member Function Documentation

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ setType()

◆ timeDerivativeActivation()