Biorbd Release_1.13.0
Loading...
Searching...
No Matches
MuscleGroup.h
1#ifndef BIORBD_MUSCLES_MUSCLE_GROUP_H
2#define BIORBD_MUSCLES_MUSCLE_GROUP_H
3
4#include "biorbdConfig.h"
5
6#include <memory>
7#include <vector>
8
9#include "InternalForces/Muscles/MusclesEnums.h"
10
11namespace BIORBD_NAMESPACE {
12namespace utils {
13class String;
14}
15
16namespace internal_forces {
17class PathModifiers;
18
19namespace muscles {
20class MuscleGeometry;
21class Muscle;
22class Characteristics;
23
28class BIORBD_API MuscleGroup {
29 public:
34
39 MuscleGroup(const MuscleGroup& other);
40
48 const utils::String& name,
49 const utils::String& originName,
50 const utils::String& insertionName);
51
55 virtual ~MuscleGroup();
56
61 MuscleGroup DeepCopy() const;
62
67 void DeepCopy(const MuscleGroup& other);
68
69#ifndef SWIG
79 virtual void addMuscle(
80 const utils::String& name,
81 MUSCLE_TYPE type,
82 const MuscleGeometry& geometry,
83 const Characteristics& characteristics,
84 STATE_TYPE stateType = STATE_TYPE::NO_STATE_TYPE,
85 STATE_FATIGUE_TYPE dynamicFatigueType =
86 STATE_FATIGUE_TYPE::NO_FATIGUE_STATE_TYPE);
87
96 virtual void addMuscle(
97 const utils::String& name,
98 MUSCLE_TYPE type,
99 const MuscleGeometry& geometry,
100 const Characteristics& characteristics,
101 STATE_FATIGUE_TYPE dynamicFatigueType);
102
113 virtual void addMuscle(
114 const utils::String& name,
115 MUSCLE_TYPE type,
116 const MuscleGeometry& geometry,
117 const Characteristics& characteristics,
118 const internal_forces::PathModifiers& pathModifiers,
119 STATE_TYPE stateType = STATE_TYPE::NO_STATE_TYPE,
120 STATE_FATIGUE_TYPE dynamicFatigueType =
121 STATE_FATIGUE_TYPE::NO_FATIGUE_STATE_TYPE);
122
132 virtual void addMuscle(
133 const utils::String& name,
134 MUSCLE_TYPE type,
135 const MuscleGeometry& geometry,
136 const Characteristics& characteristics,
137 const internal_forces::PathModifiers& pathModifiers,
138 STATE_FATIGUE_TYPE dynamicFatigueType);
139#endif
140
145 virtual void addMuscle(const Muscle& muscle);
146
151 size_t nbMuscles() const;
152
157 std::vector<std::shared_ptr<Muscle>>& muscles();
158
163 const std::vector<std::shared_ptr<Muscle>>& muscles() const;
164
170 Muscle& muscle(size_t idx);
171
177 const Muscle& muscle(size_t idx) const;
178
184 int muscleID(const utils::String& name);
185
190 void setName(const utils::String& name);
191
196 const utils::String& name() const;
197
202 void setOrigin(const utils::String& name);
203
208 const utils::String& origin() const;
209
214 void setInsertion(const utils::String& name);
215
220 const utils::String& insertion() const;
221
222 protected:
223 std::shared_ptr<std::vector<std::shared_ptr<Muscle>>>
225 std::shared_ptr<utils::String> m_name;
226 std::shared_ptr<utils::String> m_originName;
227 std::shared_ptr<utils::String> m_insertName;
228};
229
230} // namespace muscles
231} // namespace internal_forces
232} // namespace BIORBD_NAMESPACE
233
234#endif // BIORBD_MUSCLES_MUSCLE_GROUP_H
Holder of all the path modifiers of a muscle.
const utils::String & origin() const
Return the origin segment name.
std::shared_ptr< utils::String > m_name
The muscle group name.
void setOrigin(const utils::String &name)
Set the origin segment name where the origin lies.
size_t nbMuscles() const
Return the number of muscles in the group.
virtual void addMuscle(const utils::String &name, MUSCLE_TYPE type, const MuscleGeometry &geometry, const Characteristics &characteristics, STATE_TYPE stateType=STATE_TYPE::NO_STATE_TYPE, STATE_FATIGUE_TYPE dynamicFatigueType=STATE_FATIGUE_TYPE::NO_FATIGUE_STATE_TYPE)
To add a muscle to the group.
std::vector< std::shared_ptr< Muscle > > & muscles()
Return the muscles in the group.
const utils::String & insertion() const
Return the insertion segment name.
std::shared_ptr< std::vector< std::shared_ptr< Muscle > > > m_mus
The set of muscles.
void setName(const utils::String &name)
Set the name of the muscle group.
int muscleID(const utils::String &name)
Return the muscle index.
void setInsertion(const utils::String &name)
Set the insertion segment name where the origin lies.
std::shared_ptr< utils::String > m_originName
The origin name.
MuscleGroup DeepCopy() const
Deep copy of a muscle group.
Muscle & muscle(size_t idx)
Return the muscle of a specific index in the group.
std::shared_ptr< utils::String > m_insertName
The insertion name.
const utils::String & name() const
Return the name of the muscle group.
Wrapper around the std::string class with augmented functionality.
Definition String.h:18