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

Class compound is a very generic definition of what a muscle is. It should be the base class of every muscles. More...

#include <Compound.h>

Inheritance diagram for BIORBD_NAMESPACE::internal_forces::Compound:
BIORBD_NAMESPACE::internal_forces::ligaments::Ligament BIORBD_NAMESPACE::internal_forces::muscles::Muscle BIORBD_NAMESPACE::internal_forces::ligaments::LigamentConstant BIORBD_NAMESPACE::internal_forces::ligaments::LigamentSpringLinear BIORBD_NAMESPACE::internal_forces::ligaments::LigamentSpringSecondOrder BIORBD_NAMESPACE::internal_forces::muscles::HillType BIORBD_NAMESPACE::internal_forces::muscles::IdealizedActuator BIORBD_NAMESPACE::internal_forces::muscles::HillDeGrooteType BIORBD_NAMESPACE::internal_forces::muscles::HillThelenType BIORBD_NAMESPACE::internal_forces::muscles::HillDeGrooteActiveOnlyType BIORBD_NAMESPACE::internal_forces::muscles::HillDeGrooteTypeFatigable BIORBD_NAMESPACE::internal_forces::muscles::HillThelenActiveOnlyType BIORBD_NAMESPACE::internal_forces::muscles::HillThelenTypeFatigable

Public Member Functions

 Compound ()
 Construct muscle compound.
 Compound (const utils::String &name)
 Construct compound.
 Compound (const utils::String &name, const internal_forces::PathModifiers &pathModifiers)
 Construct compound.
 Compound (const Compound &other)
 Construct compound from another muscle.
 Compound (const std::shared_ptr< Compound > other)
 Construct compound from another compound.
virtual ~Compound ()
 Destroy class properly.
void DeepCopy (const Compound &other)
 Deep copy of a compound.
void setName (const utils::String &name)
 Set the name of a muscle.
const utils::String & name () const
 Return the name of the muscle.
const internal_forces::PathModifiers & pathModifier ()
 Return the path modifier.
void addPathObject (utils::Vector3d &wrap)
 Add a path modifier object.
virtual const utils::Scalar & force ()
 Return the last computed muscle force norm.

Protected Attributes

std::shared_ptr< utils::String > m_name
 The name of the muscle.
std::shared_ptr< internal_forces::PathModifiers > m_pathChanger
 The set of path modifiers.
std::shared_ptr< utils::Scalar > m_force
 The last computed force.

Detailed Description

Class compound is a very generic definition of what a muscle is. It should be the base class of every muscles.

Definition at line 29 of file Compound.h.

Constructor & Destructor Documentation

◆ Compound() [1/5]

internal_forces::Compound::Compound ( )

Construct muscle compound.

Definition at line 11 of file Compound.cpp.

◆ Compound() [2/5]

internal_forces::Compound::Compound ( const utils::String & name)

Construct compound.

Parameters
nameName of the compound

Definition at line 16 of file Compound.cpp.

◆ Compound() [3/5]

internal_forces::Compound::Compound ( const utils::String & name,
const internal_forces::PathModifiers & pathModifiers )

Construct compound.

Parameters
nameName of the compound
pathModifiersThe set of path modifiers

Definition at line 21 of file Compound.cpp.

◆ Compound() [4/5]

internal_forces::Compound::Compound ( const Compound & other)

Construct compound from another muscle.

Parameters
otherThe muscle to shallow copy

Definition at line 29 of file Compound.cpp.

◆ Compound() [5/5]

internal_forces::Compound::Compound ( const std::shared_ptr< Compound > other)

Construct compound from another compound.

Parameters
otherThe compound to shallow copy

Definition at line 34 of file Compound.cpp.

◆ ~Compound()

internal_forces::Compound::~Compound ( )
virtual

Destroy class properly.

Definition at line 39 of file Compound.cpp.

Member Function Documentation

◆ addPathObject()

void internal_forces::Compound::addPathObject ( utils::Vector3d & wrap)

Add a path modifier object.

Parameters
wrapPosition of the object

Definition at line 59 of file Compound.cpp.

◆ DeepCopy()

void internal_forces::Compound::DeepCopy ( const Compound & other)

Deep copy of a compound.

Parameters
otherCompound to copy

Definition at line 41 of file Compound.cpp.

◆ force()

const utils::Scalar & internal_forces::Compound::force ( )
virtual

Return the last computed muscle force norm.

Returns
The last computed muscle force norm

Reimplemented in BIORBD_NAMESPACE::internal_forces::ligaments::Ligament.

Definition at line 63 of file Compound.cpp.

◆ name()

const utils::String & internal_forces::Compound::name ( ) const

Return the name of the muscle.

Returns
The name of the muscle

Definition at line 48 of file Compound.cpp.

◆ pathModifier()

const internal_forces::PathModifiers & internal_forces::Compound::pathModifier ( )

Return the path modifier.

Returns
The path modifier

Definition at line 55 of file Compound.cpp.

◆ setName()

void internal_forces::Compound::setName ( const utils::String & name)

Set the name of a muscle.

Parameters
nameName of the muscle

Definition at line 50 of file Compound.cpp.

Member Data Documentation

◆ m_force

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::Compound::m_force
protected

The last computed force.

Definition at line 108 of file Compound.h.

◆ m_name

std::shared_ptr<utils::String> BIORBD_NAMESPACE::internal_forces::Compound::m_name
protected

The name of the muscle.

Definition at line 105 of file Compound.h.

◆ m_pathChanger

std::shared_ptr<internal_forces::PathModifiers> BIORBD_NAMESPACE::internal_forces::Compound::m_pathChanger
protected

The set of path modifiers.

Definition at line 107 of file Compound.h.


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