|
Biorbd Release_1.13.0
|
Class Holds that ligament characteristics. More...
#include <LigamentCharacteristics.h>
Public Member Functions | |
| LigamentCharacteristics () | |
| Construct characteristics. | |
| LigamentCharacteristics (const LigamentCharacteristics &other) | |
| Construct characteristics from other characteristics. | |
| LigamentCharacteristics (const utils::Scalar &ligamentSlackLength, const utils::Scalar &cste_damping=0, const utils::Scalar &cste_maxShorteningSpeed=1) | |
| Construct characteristics. | |
| virtual | ~LigamentCharacteristics () |
| Destroy the class properly. | |
| LigamentCharacteristics | DeepCopy () const |
| Deep copy of characteristics. | |
| void | DeepCopy (const LigamentCharacteristics &other) |
| Deep copy of characteristics from another characteristics. | |
| void | setLigamentSlackLength (const utils::Scalar &val) |
| Set the tendon slack length. | |
| const utils::Scalar & | ligamentSlackLength () const |
| Return the tendon slack length. | |
| void | setDampingParam (const utils::Scalar &val) |
| Choose if use damping for ligament force computation. | |
| const utils::Scalar & | dampingParam () const |
| Return 1 if use damping for ligament computation. | |
| void | setMaxShorteningSpeed (const utils::Scalar &val) |
| Choose if use damping for ligament force computation. | |
| const utils::Scalar & | maxShorteningSpeed () const |
| Return 1 if use damping for ligament computation. | |
Protected Attributes | |
| std::shared_ptr< utils::Scalar > | m_ligamentSlackLength |
| Ligament slack length. | |
| std::shared_ptr< utils::Scalar > | m_cste_damping |
| Ligament damping parameters (0 no damping). | |
| std::shared_ptr< utils::Scalar > | m_cste_maxShorteningSpeed |
| Ligament shorteningSpeed. | |
Class Holds that ligament characteristics.
Definition at line 19 of file LigamentCharacteristics.h.
| internal_forces::ligaments::LigamentCharacteristics::LigamentCharacteristics | ( | ) |
Construct characteristics.
Definition at line 6 of file LigamentCharacteristics.cpp.
| internal_forces::ligaments::LigamentCharacteristics::LigamentCharacteristics | ( | const LigamentCharacteristics & | other | ) |
Construct characteristics from other characteristics.
| other | The other characteristics |
Definition at line 11 of file LigamentCharacteristics.cpp.
| internal_forces::ligaments::LigamentCharacteristics::LigamentCharacteristics | ( | const utils::Scalar & | ligamentSlackLength, |
| const utils::Scalar & | cste_damping = 0, | ||
| const utils::Scalar & | cste_maxShorteningSpeed = 1 ) |
Construct characteristics.
| ligamentSlackLength | The ligament slack length |
| cste_damping | The ligament damping parameter (0 for no damping) |
| cste_maxShorteningSpeed | The ligament maximal shortening speed |
Definition at line 17 of file LigamentCharacteristics.cpp.
|
virtual |
Destroy the class properly.
Definition at line 29 of file LigamentCharacteristics.cpp.
| const utils::Scalar & internal_forces::ligaments::LigamentCharacteristics::dampingParam | ( | ) | const |
Return 1 if use damping for ligament computation.
Definition at line 71 of file LigamentCharacteristics.cpp.
| internal_forces::ligaments::LigamentCharacteristics internal_forces::ligaments::LigamentCharacteristics::DeepCopy | ( | ) | const |
Deep copy of characteristics.
Definition at line 33 of file LigamentCharacteristics.cpp.
| void internal_forces::ligaments::LigamentCharacteristics::DeepCopy | ( | const LigamentCharacteristics & | other | ) |
Deep copy of characteristics from another characteristics.
| other | The characteristics to copy from |
Definition at line 39 of file LigamentCharacteristics.cpp.
| const utils::Scalar & internal_forces::ligaments::LigamentCharacteristics::ligamentSlackLength | ( | ) | const |
Return the tendon slack length.
Definition at line 51 of file LigamentCharacteristics.cpp.
| const utils::Scalar & internal_forces::ligaments::LigamentCharacteristics::maxShorteningSpeed | ( | ) | const |
Return 1 if use damping for ligament computation.
Definition at line 61 of file LigamentCharacteristics.cpp.
| void internal_forces::ligaments::LigamentCharacteristics::setDampingParam | ( | const utils::Scalar & | val | ) |
Choose if use damping for ligament force computation.
| val | 0 to not use damping |
Definition at line 66 of file LigamentCharacteristics.cpp.
| void internal_forces::ligaments::LigamentCharacteristics::setLigamentSlackLength | ( | const utils::Scalar & | val | ) |
Set the tendon slack length.
| val | Value of the tendon slack length |
Definition at line 46 of file LigamentCharacteristics.cpp.
| void internal_forces::ligaments::LigamentCharacteristics::setMaxShorteningSpeed | ( | const utils::Scalar & | val | ) |
Choose if use damping for ligament force computation.
| val | 0 to not use damping |
Definition at line 56 of file LigamentCharacteristics.cpp.
|
protected |
Ligament damping parameters (0 no damping).
Definition at line 99 of file LigamentCharacteristics.h.
|
protected |
Ligament shorteningSpeed.
Definition at line 101 of file LigamentCharacteristics.h.
|
protected |
Ligament slack length.
Definition at line 97 of file LigamentCharacteristics.h.