A muscle group is muscle that share parents for both origin and insertion. More...

#include <MuscleGroup.h>

Public Member Functions
	MuscleGroup ()
	Construct a muscle group.

	MuscleGroup (const biorbd::muscles::MuscleGroup &other)
	Construct a muscle group from another muscle group. More...

	MuscleGroup (const biorbd::utils::String &name, const biorbd::utils::String &originName, const biorbd::utils::String &insertionName)
	Construct a muscle group. More...

virtual	~MuscleGroup ()
	Destroy class properly.

biorbd::muscles::MuscleGroup	DeepCopy () const
	Deep copy of a muscle group. More...

void	DeepCopy (const biorbd::muscles::MuscleGroup &other)
	Deep copy of a muscle group in new muscle group. More...

virtual void	addMuscle (const biorbd::utils::String &name, biorbd::muscles::MUSCLE_TYPE type, const biorbd::muscles::Geometry &geometry, const biorbd::muscles::Characteristics &characteristics, biorbd::muscles::STATE_TYPE stateType=biorbd::muscles::STATE_TYPE::NO_STATE_TYPE, biorbd::muscles::STATE_FATIGUE_TYPE dynamicFatigueType=biorbd::muscles::STATE_FATIGUE_TYPE::NO_FATIGUE_STATE_TYPE)
	To add a muscle to the group. More...

virtual void	addMuscle (const biorbd::utils::String &name, biorbd::muscles::MUSCLE_TYPE type, const biorbd::muscles::Geometry &geometry, const biorbd::muscles::Characteristics &characteristics, biorbd::muscles::STATE_FATIGUE_TYPE dynamicFatigueType)
	To add a muscle to the group. More...

virtual void	addMuscle (const biorbd::utils::String &name, biorbd::muscles::MUSCLE_TYPE type, const biorbd::muscles::Geometry &geometry, const biorbd::muscles::Characteristics &characteristics, const biorbd::muscles::PathModifiers &pathModifiers, biorbd::muscles::STATE_TYPE stateType=biorbd::muscles::STATE_TYPE::NO_STATE_TYPE, biorbd::muscles::STATE_FATIGUE_TYPE dynamicFatigueType=biorbd::muscles::STATE_FATIGUE_TYPE::NO_FATIGUE_STATE_TYPE)
	To add a muscle to the group. More...

virtual void	addMuscle (const biorbd::utils::String &name, biorbd::muscles::MUSCLE_TYPE type, const biorbd::muscles::Geometry &geometry, const biorbd::muscles::Characteristics &characteristics, const biorbd::muscles::PathModifiers &pathModifiers, biorbd::muscles::STATE_FATIGUE_TYPE dynamicFatigueType)
	To add a muscle to the group. More...

virtual void	addMuscle (const biorbd::muscles::Muscle &muscle)
	To add a muscle to the group. More...

unsigned int	nbMuscles () const
	Return the number of muscles in the group. More...

std::vector< std::shared_ptr< biorbd::muscles::Muscle > > &	muscles ()
	Return the muscles in the group. More...

const std::vector< std::shared_ptr< biorbd::muscles::Muscle > > &	muscles () const
	Return the muscles in the group. More...

biorbd::muscles::Muscle &	muscle (unsigned int idx)
	Return the muscle of a specific index in the group. More...

const biorbd::muscles::Muscle &	muscle (unsigned int idx) const
	Return the muscle of a specific index in the group. More...

int	muscleID (const biorbd::utils::String &name)
	Return the muscle index. More...

void	setName (const biorbd::utils::String &name)
	Set the name of the muscle group. More...

const biorbd::utils::String &	name () const
	Return the name of the muscle group. More...

void	setOrigin (const biorbd::utils::String &name)
	Set the origin segment name where the origin lies. More...

const biorbd::utils::String &	origin () const
	Return the origin segment name. More...

void	setInsertion (const biorbd::utils::String &name)
	Set the insertion segment name where the origin lies. More...

const biorbd::utils::String &	insertion () const
	Return the insertion segment name. More...

Protected Attributes
std::shared_ptr< std::vector< std::shared_ptr< biorbd::muscles::Muscle > > >	m_mus
	The set of muscles.

std::shared_ptr< biorbd::utils::String >	m_name
	The muscle group name.

std::shared_ptr< biorbd::utils::String >	m_originName
	The origin name.

std::shared_ptr< biorbd::utils::String >	m_insertName
	The insertion name.

Detailed Description

A muscle group is muscle that share parents for both origin and insertion.

Definition at line 22 of file MuscleGroup.h.

Constructor & Destructor Documentation

◆ MuscleGroup() [1/2]

biorbd::muscles::MuscleGroup::MuscleGroup ( const biorbd::muscles::MuscleGroup & other )

Construct a muscle group from another muscle group.

Parameters

other The other muscle group

Definition at line 21 of file MuscleGroup.cpp.

◆ MuscleGroup() [2/2]

biorbd::muscles::MuscleGroup::MuscleGroup	(	const biorbd::utils::String &	name,
		const biorbd::utils::String &	originName,
		const biorbd::utils::String &	insertionName
	)

Construct a muscle group.

Parameters

name	The name of the muscle group
originName	The segment name where the origin lies
insertionName	The segment name where the insertion lies

Definition at line 30 of file MuscleGroup.cpp.

Member Function Documentation

◆ addMuscle() [1/5]

void biorbd::muscles::MuscleGroup::addMuscle ( const biorbd::muscles::Muscle & muscle )

virtual

To add a muscle to the group.

Parameters

muscle The muscle to add

Definition at line 195 of file MuscleGroup.cpp.

◆ addMuscle() [2/5]

void biorbd::muscles::MuscleGroup::addMuscle	(	const biorbd::utils::String &	name,
		biorbd::muscles::MUSCLE_TYPE	type,
		const biorbd::muscles::Geometry &	geometry,
		const biorbd::muscles::Characteristics &	characteristics,
		biorbd::muscles::STATE_FATIGUE_TYPE	dynamicFatigueType
	)

virtual

To add a muscle to the group.

Parameters

name	The name of the muscle
type	The muscle type
geometry	The geometry of the muscle
characteristics	The muscle characteristics
dynamicFatigueType	The dynamic state fatigue type

Definition at line 110 of file MuscleGroup.cpp.

◆ addMuscle() [3/5]

void biorbd::muscles::MuscleGroup::addMuscle	(	const biorbd::utils::String &	name,
		biorbd::muscles::MUSCLE_TYPE	type,
		const biorbd::muscles::Geometry &	geometry,
		const biorbd::muscles::Characteristics &	characteristics,
		biorbd::muscles::STATE_TYPE	stateType = `biorbd::muscles::STATE_TYPE::NO_STATE_TYPE`,
		biorbd::muscles::STATE_FATIGUE_TYPE	dynamicFatigueType = `biorbd::muscles::STATE_FATIGUE_TYPE::NO_FATIGUE_STATE_TYPE`
	)

virtual

To add a muscle to the group.

Parameters

name	The name of the muscle
type	The muscle type
geometry	The geometry of the muscle
characteristics	The muscle characteristics
stateType	The state stype
dynamicFatigueType	The dynamic state fatigue type

Definition at line 74 of file MuscleGroup.cpp.

◆ addMuscle() [4/5]

void biorbd::muscles::MuscleGroup::addMuscle	(	const biorbd::utils::String &	name,
		biorbd::muscles::MUSCLE_TYPE	type,
		const biorbd::muscles::Geometry &	geometry,
		const biorbd::muscles::Characteristics &	characteristics,
		const biorbd::muscles::PathModifiers &	pathModifiers,
		biorbd::muscles::STATE_FATIGUE_TYPE	dynamicFatigueType
	)

virtual

To add a muscle to the group.

Parameters

name	Name of the muscle
type	The muscle type
geometry	The geometry of the muscle
characteristics	The muscle characteristics
pathModifiers	The set of path modifiers
dynamicFatigueType	The dynamic state fatigue type

Definition at line 172 of file MuscleGroup.cpp.

◆ addMuscle() [5/5]

void biorbd::muscles::MuscleGroup::addMuscle	(	const biorbd::utils::String &	name,
		biorbd::muscles::MUSCLE_TYPE	type,
		const biorbd::muscles::Geometry &	geometry,
		const biorbd::muscles::Characteristics &	characteristics,
		const biorbd::muscles::PathModifiers &	pathModifiers,
		biorbd::muscles::STATE_TYPE	stateType = `biorbd::muscles::STATE_TYPE::NO_STATE_TYPE`,
		biorbd::muscles::STATE_FATIGUE_TYPE	dynamicFatigueType = `biorbd::muscles::STATE_FATIGUE_TYPE::NO_FATIGUE_STATE_TYPE`
	)

virtual

To add a muscle to the group.

Parameters

name	The name of the muscle
type	The muscle type
geometry	The geometry of the muscle
characteristics	The muscle characteristics
pathModifiers	The set of path modifiers
stateType	The state stype
dynamicFatigueType	The dynamic state fatigue type

Definition at line 131 of file MuscleGroup.cpp.

◆ DeepCopy() [1/2]

biorbd::muscles::MuscleGroup biorbd::muscles::MuscleGroup::DeepCopy ( ) const

Deep copy of a muscle group.

Returns: A deep copy of a muscle group

Definition at line 46 of file MuscleGroup.cpp.

◆ DeepCopy() [2/2]

void biorbd::muscles::MuscleGroup::DeepCopy ( const biorbd::muscles::MuscleGroup & other )

Deep copy of a muscle group in new muscle group.

Parameters

other The muscle group to copy

Definition at line 53 of file MuscleGroup.cpp.

◆ insertion()

const biorbd::utils::String & biorbd::muscles::MuscleGroup::insertion ( ) const

Return the insertion segment name.

Returns: The insertion segment name

Definition at line 266 of file MuscleGroup.cpp.

◆ muscle() [1/2]

biorbd::muscles::Muscle & biorbd::muscles::MuscleGroup::muscle ( unsigned int idx )

Return the muscle of a specific index in the group.

Parameters

idx	The muscle index

Returns: The muscle of a specific index

Definition at line 214 of file MuscleGroup.cpp.

◆ muscle() [2/2]

const biorbd::muscles::Muscle & biorbd::muscles::MuscleGroup::muscle ( unsigned int idx ) const

Return the muscle of a specific index in the group.

Parameters

idx	The muscle index

Returns: The muscle of a specific index

Definition at line 219 of file MuscleGroup.cpp.

◆ muscleID()

int biorbd::muscles::MuscleGroup::muscleID ( const biorbd::utils::String & name )

Return the muscle index.

Parameters

name	The name of the muscle

Returns: The muscle index

Definition at line 240 of file MuscleGroup.cpp.

◆ muscles() [1/2]

std::vector< std::shared_ptr< biorbd::muscles::Muscle > > & biorbd::muscles::MuscleGroup::muscles ( )

Return the muscles in the group.

Returns: The muscles

Definition at line 230 of file MuscleGroup.cpp.

◆ muscles() [2/2]

const std::vector< std::shared_ptr< biorbd::muscles::Muscle > > & biorbd::muscles::MuscleGroup::muscles ( ) const

Return the muscles in the group.

Returns: The muscles

Definition at line 235 of file MuscleGroup.cpp.

◆ name()

const biorbd::utils::String & biorbd::muscles::MuscleGroup::name ( ) const

Return the name of the muscle group.

Returns: The name of the muscle

Definition at line 252 of file MuscleGroup.cpp.

◆ nbMuscles()

unsigned int biorbd::muscles::MuscleGroup::nbMuscles ( ) const

Return the number of muscles in the group.

Returns: The number of muscles in the group

Definition at line 226 of file MuscleGroup.cpp.

◆ origin()

const biorbd::utils::String & biorbd::muscles::MuscleGroup::origin ( ) const

Return the origin segment name.

Returns: The origin segment name

Definition at line 259 of file MuscleGroup.cpp.

◆ setInsertion()

void biorbd::muscles::MuscleGroup::setInsertion ( const biorbd::utils::String & name )

Set the insertion segment name where the origin lies.

Parameters

name	The insertion segment name where the origin lies

Definition at line 263 of file MuscleGroup.cpp.

◆ setName()

void biorbd::muscles::MuscleGroup::setName ( const biorbd::utils::String & name )

Set the name of the muscle group.

Parameters

name	The name of the muscle group

Definition at line 249 of file MuscleGroup.cpp.

◆ setOrigin()

void biorbd::muscles::MuscleGroup::setOrigin ( const biorbd::utils::String & name )

Set the origin segment name where the origin lies.

Parameters

name	The origin segment name where the origin lies

Definition at line 256 of file MuscleGroup.cpp.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MuscleGroup() [1/2]

◆ MuscleGroup() [2/2]

Member Function Documentation

◆ addMuscle() [1/5]

◆ addMuscle() [2/5]

◆ addMuscle() [3/5]

◆ addMuscle() [4/5]

◆ addMuscle() [5/5]

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ insertion()

◆ muscle() [1/2]

◆ muscle() [2/2]

◆ muscleID()

◆ muscles() [1/2]

◆ muscles() [2/2]

◆ name()

◆ nbMuscles()

◆ origin()

◆ setInsertion()

◆ setName()

◆ setOrigin()