1 #ifndef SimTK_SimTKCOMMON_SUBSYSTEM_H_ 2 #define SimTK_SimTKCOMMON_SUBSYSTEM_H_ 89 {
return s.
allocateQ(getMySubsystemIndex(), qInit); }
91 {
return s.
allocateU(getMySubsystemIndex(), uInit); }
93 {
return s.
allocateZ(getMySubsystemIndex(), zInit); }
101 (getMySubsystemIndex(),invalidates,v,updateDependsOn); }
105 (getMySubsystemIndex(), dependsOn, computedBy, v); }
109 {
return allocateCacheEntry(state, g, g, v); }
115 {
return s.
allocateQErr(getMySubsystemIndex(), nqerr); }
117 {
return s.
allocateUErr(getMySubsystemIndex(), nuerr); }
125 {
return s.
getQ(getMySubsystemIndex()); }
127 {
return s.
getU(getMySubsystemIndex()); }
129 {
return s.
getZ(getMySubsystemIndex()); }
140 {
return s.
getQDot(getMySubsystemIndex()); }
142 {
return s.
getUDot(getMySubsystemIndex()); }
144 {
return s.
getZDot(getMySubsystemIndex()); }
146 {
return s.
getQDotDot(getMySubsystemIndex()); }
149 {
return s.
updQDot(getMySubsystemIndex()); }
151 {
return s.
updUDot(getMySubsystemIndex()); }
153 {
return s.
updZDot(getMySubsystemIndex()); }
155 {
return s.
updQDotDot(getMySubsystemIndex()); }
158 {
return s.
getQErr(getMySubsystemIndex()); }
160 {
return s.
getUErr(getMySubsystemIndex()); }
167 {
return s.
getUDotErr(getMySubsystemIndex()); }
174 {
return s.
updQErr(getMySubsystemIndex()); }
176 {
return s.
updUErr(getMySubsystemIndex()); }
178 {
return s.
updUDotErr(getMySubsystemIndex()); }
185 {
return s.
getQStart(getMySubsystemIndex()); }
187 {
return s.
getNQ(getMySubsystemIndex()); }
190 {
return s.
getUStart(getMySubsystemIndex()); }
192 {
return s.
getNU(getMySubsystemIndex()); }
195 {
return s.
getZStart(getMySubsystemIndex()); }
197 {
return s.
getNZ(getMySubsystemIndex()); }
202 {
return s.
getNQErr(getMySubsystemIndex()); }
207 {
return s.
getNUErr(getMySubsystemIndex()); }
264 bool isDiscreteVarUpdateValueRealized
267 void markDiscreteVarUpdateValueRealized
288 inline const String& getName()
const;
291 inline const String& getVersion()
const;
294 inline bool isInSystem()
const;
298 inline bool isInSameSystem(
const Subsystem& otherSubsystem)
const;
303 inline const System& getSystem()
const;
307 inline System& updSystem();
323 {
return guts && (guts==otherSubsystem.guts); }
328 inline bool isOwnerHandle()
const;
333 inline bool subsystemTopologyHasBeenRealized()
const;
342 inline void invalidateSubsystemTopologyCache()
const;
374 #endif // SimTK_SimTKCOMMON_SUBSYSTEM_H_ const Vector & getZWeights(SubsystemIndex) const
const Vector & getEventTriggersByStage(const State &s, Stage g) const
Definition: Subsystem.h:170
AbstractValue & updDiscreteVarUpdateValue(SubsystemIndex, DiscreteVariableIndex) const
For an auto-updating discrete variable, return a writable reference to the value of its associated up...
Vector & updUErr(SubsystemIndex) const
Vector & updEventTriggersByStage(const State &s, Stage g) const
Definition: Subsystem.h:181
A Subsystem is expected to be part of a larger System and to have interdependencies with other subsys...
Definition: Subsystem.h:55
const Vector & getQDotDot(SubsystemIndex) const
Vector & updQ(SubsystemIndex)
SystemYErrIndex getUErrStart() const
Returns the yErr index at which the uErr's begin. Callable at Instance stage.
#define SimTK_SimTKCOMMON_EXPORT
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:218
const Vector & getZDot(SubsystemIndex) const
const Vector & getQErr(SubsystemIndex) const
int getNQ(const State &s) const
Definition: Subsystem.h:186
const Vector & getZ(SubsystemIndex) const
Unique integer type for Subsystem-local uDotErr indexing.
Vector & updMultipliers(SubsystemIndex) const
Vector & updUErr(const State &s) const
Definition: Subsystem.h:175
Vector & updQErr(SubsystemIndex) const
SystemMultiplierIndex getMultipliersStart(const State &s) const
Definition: Subsystem.h:214
bool isDiscreteVarUpdateValueRealized(SubsystemIndex, DiscreteVariableIndex) const
Check whether the update value for this auto-update discrete variable has already been computed since...
void advanceToStage(const State &s, Stage g) const
Definition: Subsystem.h:241
const Vector & getU(const State &s) const
Definition: Subsystem.h:126
int getNEventTriggersByStage(const State &s, Stage g) const
Definition: Subsystem.h:221
const Stage & getSubsystemStage(SubsystemIndex) const
int getNU() const
Get total number of shared u's (generalized speeds; mobilities).
AbstractValue & updCacheEntry(SubsystemIndex, CacheEntryIndex) const
Retrieve a writable reference to the value contained in a particular cache entry. ...
void markCacheValueNotRealized(SubsystemIndex, CacheEntryIndex) const
Normally cache entries are invalidated automatically, however this method allows manual invalidation ...
void advanceSubsystemToStage(SubsystemIndex, Stage) const
Advance a particular Subsystem's current stage by one to the indicated stage.
QErrIndex allocateQErr(SubsystemIndex, int nqerr) const
Allocate nqerr cache slots to hold the current error for position-level (holonomic) constraint equati...
Unique integer type for Subsystem-local u indexing.
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37
CacheEntryIndex allocateCacheEntry(SubsystemIndex, Stage earliest, Stage latest, AbstractValue *) const
There are two Stages supplied explicitly as arguments to this method: earliest and latest...
Vector & updMultipliers(const State &s) const
Definition: Subsystem.h:179
Real getDiscreteVarLastUpdateTime(const State &s, DiscreteVariableIndex dx) const
Definition: Subsystem.h:253
Unique integer type for Subsystem-local uErr indexing.
Real getDiscreteVarLastUpdateTime(SubsystemIndex, DiscreteVariableIndex) const
Return the time of last update for this discrete variable.
CacheEntryIndex getDiscreteVarUpdateIndex(const State &s, DiscreteVariableIndex dx) const
Definition: Subsystem.h:256
Unique integer type for Subsystem-local qErr indexing.
This class is basically a glorified enumerated type, type-safe and range checked but permitting conve...
Definition: Stage.h:50
SystemEventTriggerIndex getEventTriggerStartByStage(Stage) const
Return the index within the global event trigger array at which the first of the event triggers assoc...
Vector & updQErr(const State &s) const
Definition: Subsystem.h:173
EventTriggerByStageIndex allocateEventTriggersByStage(const State &s, Stage g, int ntriggers) const
Definition: Subsystem.h:121
int getNQErr() const
Return the total number nqerr=mp+nQuaternions of cache entries for position-level constraint errors...
SystemUIndex getUStart(const State &s) const
Definition: Subsystem.h:189
int size() const
Definition: VectorBase.h:396
AbstractValue & updDiscreteVariable(State &s, DiscreteVariableIndex index) const
Definition: Subsystem.h:247
const AbstractValue & getDiscreteVariable(SubsystemIndex, DiscreteVariableIndex) const
Get the current value of the indicated discrete variable.
UDotErrIndex allocateUDotErr(SubsystemIndex, int nudoterr) const
Allocate nudoterr cache slots to hold the current error for acceleration-level (acceleration-only, nonholonomic first derivative, and holonomic second derivative) constraint equations.
SystemYIndex getUStart() const
Returns the y index at which the u's begin. Callable at Model stage.
CacheEntryIndex getDiscreteVarUpdateIndex(SubsystemIndex, DiscreteVariableIndex) const
For an auto-updating discrete variable, return the CacheEntryIndex for its associated update cache en...
SystemEventTriggerByStageIndex getEventTriggerStartByStage(const State &s, Stage g) const
Definition: Subsystem.h:219
int getNUDotErr(const State &s) const
Definition: Subsystem.h:211
Vector & updU(State &s) const
Definition: Subsystem.h:136
#define SimTK_ASSERT(cond, msg)
Definition: ExceptionMacros.h:374
SystemUDotErrIndex getUDotErrStart(SubsystemIndex) const
void setU(State &s, const Vector &u) const
Definition: Subsystem.h:230
bool isCacheValueRealized(SubsystemIndex, CacheEntryIndex) const
Check whether the value in a particular cache entry has been recalculated since the last change to th...
const AbstractValue & getDiscreteVariable(const State &s, DiscreteVariableIndex index) const
Definition: Subsystem.h:245
int getNMultipliers() const
Return the total number of constraint multipliers; necessarily the same as the number of acceleration...
This is the base class for all Measure handle classes.
Definition: Measure.h:151
int getNZ(const State &s) const
Definition: Subsystem.h:196
SimTK_Real Real
This is the default compiled-in floating point type for SimTK, either float or double.
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:593
int getNUErr() const
Return the total number nuerr=mp+mv of cache entries for velocity-level constraint errors (including ...
Vector & updZ(State &s) const
Definition: Subsystem.h:137
Vector & updUDotErr(SubsystemIndex) const
This unique integer type is for indexing global "multiplier-like" arrays, that is, arrays that inherently have the same dimension as the total number of Lagrange multipliers in the full System-level view of the State.
bool isSameSubsystem(const Subsystem &otherSubsystem) const
Determine if this Subsystem handle refers to the same Subsystem::Guts object as handle otherSubsystem...
Definition: Subsystem.h:322
This object is intended to contain all state information for a SimTK::System, except topological info...
Definition: State.h:276
const Subsystem::Guts & getSubsystemGuts() const
Obtain the Subsystem name if one was given on construction of the concrete Subsystem.
Definition: Subsystem.h:353
This file declares the base class AbstractMeasure for all derived Measure handle classes, and the handle classes for built-in Measures.
int getNQ() const
Get total number of shared q's (generalized coordinates; second order state variables).
QIndex allocateQ(State &s, const Vector &qInit) const
Definition: Subsystem.h:88
const Vector & getQErrWeights(SubsystemIndex) const
SystemUErrIndex getUErrStart(const State &s) const
Definition: Subsystem.h:204
Stage getStage(const State &s) const
Definition: Subsystem.h:239
const Vector & getUWeights(SubsystemIndex) const
AbstractValue & updDiscreteVariable(SubsystemIndex, DiscreteVariableIndex)
Get a writable reference to the value stored in the indicated discrete state variable dv...
Vector & updU(SubsystemIndex)
UErrIndex allocateUErr(const State &s, int nuerr) const
Definition: Subsystem.h:116
const Vector & getUDotErr(const State &s) const
Definition: Subsystem.h:166
DiscreteVariableIndex allocateAutoUpdateDiscreteVariable(SubsystemIndex, Stage invalidates, AbstractValue *, Stage updateDependsOn)
This method allocates a DiscreteVariable whose value should be updated automatically after each time ...
void markCacheValueNotRealized(const State &s, CacheEntryIndex cx) const
Definition: Subsystem.h:275
Subsystem::Guts & updSubsystemGuts()
Obtain the Subsystem name if one was given on construction of the concrete Subsystem.
Definition: Subsystem.h:354
ZIndex allocateZ(State &s, const Vector &zInit) const
Definition: Subsystem.h:92
bool isCacheValueRealized(const State &s, CacheEntryIndex cx) const
Definition: Subsystem.h:271
const AbstractValue & getDiscreteVarUpdateValue(const State &s, DiscreteVariableIndex dx) const
Definition: Subsystem.h:259
DiscreteVariableIndex allocateDiscreteVariable(State &s, Stage g, AbstractValue *v) const
Definition: Subsystem.h:96
const Vector & getUDotErr(SubsystemIndex) const
AbstractValue & updCacheEntry(const State &s, CacheEntryIndex index) const
Definition: Subsystem.h:251
UDotErrIndex allocateUDotErr(const State &s, int nudoterr) const
Definition: Subsystem.h:118
This unique integer type is for indexing global "q-like" arrays, that is, arrays that inherently have...
This unique integer type is for indexing global "qErr-like" arrays, that is, arrays that inherently h...
Unique integer type for Subsystem-local z indexing.
void setQ(State &s, const Vector &q) const
Definition: Subsystem.h:226
This unique integer type is for indexing global "uErr-like" arrays, that is, arrays that inherently h...
const Vector & getUErr(const State &s) const
Definition: Subsystem.h:159
void markCacheValueRealized(const State &s, CacheEntryIndex cx) const
Definition: Subsystem.h:273
const Vector & getZDot(const State &s) const
Definition: Subsystem.h:143
SystemZIndex getZStart(const State &s) const
Definition: Subsystem.h:194
SystemYIndex getQStart() const
Returns the y index at which the q's begin. Callable at Model stage.
DiscreteVariableIndex allocateDiscreteVariable(SubsystemIndex, Stage invalidates, AbstractValue *)
The Stage supplied here in the call is the earliest subsystem stage which is invalidated by a change ...
Unique integer type for Subsystem-local q indexing.
const Vector & getQDotDot(const State &s) const
Definition: Subsystem.h:145
Subsystem(Subsystem::Guts *g)
Obtain the Subsystem name if one was given on construction of the concrete Subsystem.
Definition: Subsystem.h:361
AbstractValue & updDiscreteVarUpdateValue(const State &s, DiscreteVariableIndex dx) const
Definition: Subsystem.h:262
The abstract parent of all Subsystem implementation classes.
Definition: SubsystemGuts.h:47
const AbstractValue & getCacheEntry(const State &s, CacheEntryIndex index) const
Definition: Subsystem.h:249
QErrIndex allocateQErr(const State &s, int nqerr) const
Definition: Subsystem.h:114
const Vector & getZ(const State &s) const
Definition: Subsystem.h:128
Higher than any legitimate Stage.
Definition: Stage.h:63
UIndex allocateU(State &s, const Vector &uInit) const
Definition: Subsystem.h:90
int getNQErr(const State &s) const
Definition: Subsystem.h:201
Vector & updQ(State &s) const
Definition: Subsystem.h:135
const Vector & getQDot(const State &s) const
Definition: Subsystem.h:139
const Vector & getUDot(const State &s) const
Definition: Subsystem.h:141
This unique integer type is for identifying a triggered event within a particular Stage of the full S...
int getNU(const State &s) const
Definition: Subsystem.h:191
const Vector & getEventTriggersByStage(Stage) const
const Vector & getMultipliers(const State &s) const
Definition: Subsystem.h:168
bool hasGuts() const
Obtain the Subsystem name if one was given on construction of the concrete Subsystem.
Definition: Subsystem.h:362
int getNUDotErr() const
Return the total number nudotErr=mp+mv+ma of cache entries for acceleration-level constraint errors (...
Vector & updQDot(SubsystemIndex) const
SimTK::String is a plug-compatible std::string replacement (plus some additional functionality) inten...
Definition: String.h:62
Declares the user-visible part of a SimTK::State, the implementation is done in a separate internal c...
const AbstractValue & getCacheEntry(SubsystemIndex, CacheEntryIndex) const
Retrieve a const reference to the value contained in a particular cache entry.
Vector & updQDot(const State &s) const
Definition: Subsystem.h:148
Abstract base class representing an arbitrary value of self-describing type.
Definition: Value.h:41
This unique integer type is for indexing global "uDotErr-like" arrays, that is, arrays that inherentl...
UErrIndex allocateUErr(SubsystemIndex, int nuerr) const
Allocate nuerr cache slots to hold the current error for velocity-level (nonholonomic and holonomic f...
const Vector & getQ(const State &s) const
Definition: Subsystem.h:124
Vector & updQDotDot(SubsystemIndex) const
SystemYIndex getZStart() const
Returns the y index at which the z's begin. Callable at Model stage.
const Vector & getZWeights(const State &s) const
Definition: Subsystem.h:132
This unique integer type is for selecting discrete variables.
const Vector & getQErrWeights(const State &s) const
Definition: Subsystem.h:161
This unique integer type is for indexing global "z-like" arrays, that is, arrays that inherently have...
Measure_< T > getMeasure_(MeasureIndex mx) const
Obtain the Subsystem name if one was given on construction of the concrete Subsystem.
Definition: Subsystem.h:348
QIndex allocateQ(SubsystemIndex, const Vector &qInit)
Allocate generalized coordinates q, which are second order continuous state variables.
const AbstractValue & getDiscreteVarUpdateValue(SubsystemIndex, DiscreteVariableIndex) const
For an auto-updating discrete variable, return the current value of its associated update cache entry...
SystemMultiplierIndex getMultipliersStart(SubsystemIndex) const
const Vector & getQ(SubsystemIndex) const
Per-subsystem access to the global shared variables.
This is the base class that serves as the parent of all SimTK System objects; most commonly Simbody's...
Definition: System.h:97
SystemUDotErrIndex getUDotErrStart(const State &s) const
Definition: Subsystem.h:209
const Vector & getMultipliers(SubsystemIndex) const
UIndex allocateU(SubsystemIndex, const Vector &uInit)
Allocate generalized speeds u, which are first order continuous state variables related to the deriva...
const Vector & getUWeights(const State &s) const
Definition: Subsystem.h:130
const Vector & getUErrWeights(SubsystemIndex) const
SystemQErrIndex getQErrStart(const State &s) const
Definition: Subsystem.h:199
Provide a unique integer type for identifying Subsystems.
const Vector & getQErr(const State &s) const
Definition: Subsystem.h:157
Subsystem()
Default constructor creates and empty handle with a null Subsystem::Guts pointer. ...
Definition: Subsystem.h:62
const Vector & getUDot(SubsystemIndex) const
Vector & updUDot(const State &s) const
Definition: Subsystem.h:150
ZIndex allocateZ(SubsystemIndex, const Vector &zInit)
Allocate auxiliary first order continuous state variables z.
This unique integer type is for selecting non-shared cache entries.
Vector & updZ(SubsystemIndex)
const Vector & getUErr(SubsystemIndex) const
This is the header which should be included in user programs that would like to make use of all the S...
Unique integer type for Subsystem-local, per-stage event indexing.
const Vector & getU(SubsystemIndex) const
int getNMultipliers(const State &s) const
Definition: Subsystem.h:216
void setZ(State &s, const Vector &z) const
Definition: Subsystem.h:234
This unique integer type is for indexing global "u-like" arrays, that is, arrays that inherently have...
void markDiscreteVarUpdateValueRealized(SubsystemIndex, DiscreteVariableIndex) const
Mark the update value for this auto-update discrete variable as up-to-date with respect to the state ...
Includes internal headers providing declarations for the basic SimTK Core classes.
Vector & updUDot(SubsystemIndex) const
bool isEmptyHandle() const
Return true if this handle has a null Subsystem::Guts pointer.
Definition: Subsystem.h:317
SystemYErrIndex getQErrStart() const
Returns the yErr index at which the qErr's begin. Callable at Instance stage.
EventTriggerByStageIndex allocateEventTrigger(SubsystemIndex, Stage stage, int nevent) const
Allocate room for nevent witness function values that will be available at the indicated stage...
Vector & updQDotDot(const State &s) const
Definition: Subsystem.h:154
const Vector & getQDot(SubsystemIndex) const
Per-subsystem access to the shared cache entries.
Vector & updZDot(const State &s) const
Definition: Subsystem.h:152
int getNUErr(const State &s) const
Definition: Subsystem.h:206
const Vector & getUErrWeights(const State &s) const
Definition: Subsystem.h:163
Vector & updZDot(SubsystemIndex) const
Vector & updEventTriggersByStage(Stage) const
Vector & updUDotErr(const State &s) const
Definition: Subsystem.h:177
This is the base handle class for all Measures whose value type is known, including all the Simbody b...
Definition: Measure.h:261
int getNZ() const
Get total number of shared z's (auxiliary state variables).
int getNEventTriggersByStage(Stage) const
Return the size of the partition of event trigger functions which are evaluated at a given Stage...
SystemQIndex getQStart(const State &s) const
Definition: Subsystem.h:184
void markCacheValueRealized(SubsystemIndex, CacheEntryIndex) const
Mark the value of a particular cache entry as up to date after it has been recalculated.