Biorbd
FatigueParameters.h
1 #ifndef BIORBD_MUSCLES_FATIGUE_PARAMETERS_H
2 #define BIORBD_MUSCLES_FATIGUE_PARAMETERS_H
3 
4 #include <memory>
5 #include "biorbdConfig.h"
6 
7 #include "Utils/Scalar.h"
8 
9 namespace biorbd {
10 namespace muscles {
11 
15 class BIORBD_API FatigueParameters
16 {
17 public:
18 
27  const biorbd::utils::Scalar& fatigueRate = 0,
28  const biorbd::utils::Scalar& recoveryRate = 0,
29  const biorbd::utils::Scalar& developFactor = 0,
30  const biorbd::utils::Scalar& recoveryFactor = 0);
31 
36  biorbd::muscles::FatigueParameters DeepCopy() const;
37 
42  void DeepCopy(
44 
49  void setFatigueRate(
50  const biorbd::utils::Scalar& fatigueRate);
51 
52  // Get and Set
57  const biorbd::utils::Scalar& fatigueRate() const;
58 
63  void setRecoveryRate(
64  const biorbd::utils::Scalar& recoveryRate);
65 
70  const biorbd::utils::Scalar& recoveryRate() const;
71 
76  void setDevelopFactor(
77  const biorbd::utils::Scalar& developFactor);
78 
83  const biorbd::utils::Scalar& developFactor() const;
84 
89  void setRecoveryFactor(
90  const biorbd::utils::Scalar& recoveryFactor);
91 
96  const biorbd::utils::Scalar& recoveryFactor() const;
97 
98 protected:
99  std::shared_ptr<biorbd::utils::Scalar> m_fatigueRate;
100  std::shared_ptr<biorbd::utils::Scalar> m_recoveryRate;
101  std::shared_ptr<biorbd::utils::Scalar> m_developFactor;
102  std::shared_ptr<biorbd::utils::Scalar> m_recoveryFactor;
103 
104 };
105 
106 }}
107 
108 #endif // BIORBD_MUSCLES_FATIGUE_PARAMETERS_H
biorbd::muscles::FatigueParameters
Class FatigueParameters that holds the muscle fatigue parameters.
Definition: FatigueParameters.h:16
biorbd::muscles::FatigueParameters::m_developFactor
std::shared_ptr< biorbd::utils::Scalar > m_developFactor
The develop factor.
Definition: FatigueParameters.h:101
biorbd::muscles::FatigueParameters::m_recoveryFactor
std::shared_ptr< biorbd::utils::Scalar > m_recoveryFactor
The recovery factor.
Definition: FatigueParameters.h:102
biorbd::muscles::FatigueParameters::m_recoveryRate
std::shared_ptr< biorbd::utils::Scalar > m_recoveryRate
The recovery rate.
Definition: FatigueParameters.h:100
biorbd::muscles::FatigueParameters::m_fatigueRate
std::shared_ptr< biorbd::utils::Scalar > m_fatigueRate
The fatigue rate.
Definition: FatigueParameters.h:99