This class is basically a glorified enumerated type, type-safe and range checked but permitting convenient (if limited) arithmetic.
More...
|
enum | Level {
Empty = 0,
Topology = 1,
Model = 2,
Instance = 3,
Time = 4,
Position = 5,
Velocity = 6,
Dynamics = 7,
Acceleration = 8,
Report = 9,
Infinity = 10,
LowestValid = Empty,
HighestValid = Infinity,
LowestRuntime = Model,
HighestRuntime = Report
} |
|
enum | {
NValid = HighestValid-LowestValid+1,
NRuntime = HighestRuntime-LowestRuntime+1
} |
|
This class is basically a glorified enumerated type, type-safe and range checked but permitting convenient (if limited) arithmetic.
Constants look like Stage::Position, and loops can be written like
Stage constants (of type Stage::Level) are implicitly converted to type Stage when necessary.
Default construction gives Stage::Empty which really means "invalid".
Enumerator |
---|
Empty |
Lower than any legitimate Stage.
|
Topology |
System topology realized.
|
Model |
Modeling choices made.
|
Instance |
Physical parameters set.
|
Time |
A new time has been realized.
|
Position |
Spatial configuration available.
|
Velocity |
Spatial velocities available.
|
Dynamics |
Forces calculated.
|
Acceleration |
Accelerations and multipliers calculated.
|
Report |
Report-only quantities evaluated.
|
Infinity |
Higher than any legitimate Stage.
|
LowestValid |
For iterating over all stage values.
|
HighestValid |
|
LowestRuntime |
For iterating over meaningful stage values.
|
HighestRuntime |
|
Enumerator |
---|
NValid |
|
NRuntime |
|
SimTK::Stage::Stage |
( |
Level |
l | ) |
|
|
inline |
SimTK::Stage::Stage |
( |
int |
l | ) |
|
|
inlineexplicit |
You can explicitly create a Stage from an int if it is in range.
SimTK::Stage::operator int |
( |
| ) |
const |
|
inline |
Stage will implicitly convert to int so you can use it as an index.
bool SimTK::Stage::operator== |
( |
Level |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator!= |
( |
Level |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator< |
( |
Level |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator<= |
( |
Level |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator> |
( |
Level |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator>= |
( |
Level |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator== |
( |
Stage |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator!= |
( |
Stage |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator< |
( |
Stage |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator<= |
( |
Stage |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator> |
( |
Stage |
other | ) |
const |
|
inline |
bool SimTK::Stage::operator>= |
( |
Stage |
other | ) |
const |
|
inline |
const Stage& SimTK::Stage::operator++ |
( |
| ) |
|
|
inline |
const Stage& SimTK::Stage::operator-- |
( |
| ) |
|
|
inline |
Stage SimTK::Stage::operator++ |
( |
int |
| ) |
|
|
inline |
Stage SimTK::Stage::operator-- |
( |
int |
| ) |
|
|
inline |
Stage SimTK::Stage::next |
( |
| ) |
const |
|
inline |
Stage SimTK::Stage::prev |
( |
| ) |
const |
|
inline |
String SimTK::Stage::getName |
( |
| ) |
const |
|
inline |
Return a printable name corresponding to the stage level currently stored in this Stage.
void SimTK::Stage::invalidate |
( |
Stage |
tooHigh | ) |
|
|
inline |
Set this Stage=min(stageNow, tooHigh-1).
bool SimTK::Stage::isInRuntimeRange |
( |
| ) |
const |
|
inline |
The documentation for this class was generated from the following file: