Biorbd Release_1.13.0
Loading...
Searching...
No Matches
State.h
1#ifndef BIORBD_MUSCLES_STATE_H
2#define BIORBD_MUSCLES_STATE_H
3
4#include "biorbdConfig.h"
5
6#include <memory>
7
8#include "InternalForces/Muscles/MusclesEnums.h"
9#include "Utils/Scalar.h"
10
11namespace BIORBD_NAMESPACE {
12namespace internal_forces {
13namespace muscles {
17class BIORBD_API State {
18 public:
24 State(
25 const utils::Scalar& excitation = 0,
26 const utils::Scalar& activation = 0);
27
32 State(const State& other);
33
37 virtual ~State();
38
43 State DeepCopy() const;
44
49 void DeepCopy(const State& other);
50
59 virtual void setExcitation(
60 const utils::Scalar& val,
61 bool turnOffWarnings = false);
62
67 const utils::Scalar& excitation() const;
68
78 const utils::Scalar& normalizeExcitation(
79 const State& emgMax,
80 bool turnOffWarnings = false);
81
86 void setExcitationNorm(const utils::Scalar& val);
87
92 const utils::Scalar& excitationNorm() const;
93
105 virtual void setActivation(
106 const utils::Scalar& val,
107 bool turnOffWarnings = false);
108
113 const utils::Scalar& activation() const;
114
119 STATE_TYPE type() const;
120
121 protected:
125 virtual void setType();
126
127 std::shared_ptr<STATE_TYPE> m_stateType;
128 std::shared_ptr<utils::Scalar> m_excitation;
129 std::shared_ptr<utils::Scalar>
131 std::shared_ptr<utils::Scalar> m_activation;
132};
133
134} // namespace muscles
135} // namespace internal_forces
136} // namespace BIORBD_NAMESPACE
137
138#endif // BIORBD_MUSCLES_STATE_H
void setExcitationNorm(const utils::Scalar &val)
Force set the normalized excitation.
Definition State.cpp:80
State DeepCopy() const
Deep copy of state.
Definition State.cpp:28
std::shared_ptr< STATE_TYPE > m_stateType
The state type.
Definition State.h:127
virtual void setActivation(const utils::Scalar &val, bool turnOffWarnings=false)
Set the muscle activation.
Definition State.cpp:89
virtual void setExcitation(const utils::Scalar &val, bool turnOffWarnings=false)
Set the muscle excitation.
Definition State.cpp:43
std::shared_ptr< utils::Scalar > m_activation
The muscle activation.
Definition State.h:131
const utils::Scalar & excitationNorm() const
Return the previously normalized excitation.
Definition State.cpp:85
const utils::Scalar & excitation() const
Return the muscle excitation.
Definition State.cpp:61
std::shared_ptr< utils::Scalar > m_excitationNorm
The normalized excitation.
Definition State.h:130
const utils::Scalar & normalizeExcitation(const State &emgMax, bool turnOffWarnings=false)
Compute and return the normalized excitation.
Definition State.cpp:65
std::shared_ptr< utils::Scalar > m_excitation
The muscle excitation.
Definition State.h:128
const utils::Scalar & activation() const
Return the muscle activation.
Definition State.cpp:117
State(const utils::Scalar &excitation=0, const utils::Scalar &activation=0)
Construct a state.
Definition State.cpp:7
STATE_TYPE type() const
Return the state type.
Definition State.cpp:121
virtual void setType()
Set the type to simple_state.
Definition State.cpp:126