Stage Class Reference

#include <Stage.h>

Inheritance diagram for Stage:

List of all members.

---

Detailed Description

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 for(Stage s=StageLowest; s <= Stage::Highest; ++s) ... Stage constants (of type Stage::Num) are implicitly converted to type Stage when necessary.

Public Types
enum	Num {   EmptyIndex = 0, TopologyIndex = 1, ModelIndex = 2, InstanceIndex = 3,   TimeIndex = 4, PositionIndex = 5, VelocityIndex = 6, DynamicsIndex = 7,   AccelerationIndex = 8, ReportIndex = 9 }
Public Member Functions
Stage	next () const
Stage	prev () const
void	invalidate (Stage tooHigh)
bool	isInRuntimeRange () const
Static Public Attributes
static const Stage	Empty
static const Stage	Topology
static const Stage	Model
static const Stage	Instance
static const Stage	Time
static const Stage	Position
static const Stage	Velocity
static const Stage	Dynamics
static const Stage	Acceleration
static const Stage	Report
static const Stage	LowestValid
static const Stage	HighestValid
static const int	NValid = ReportIndex-EmptyIndex+1
static const Stage	LowestRuntime
static const Stage	HighestRuntime
static const int	NRuntime = ReportIndex-ModelIndex+1
Friends
class	Enumeration< Stage >

---

Member Enumeration Documentation

enum Num

Enumerator:

EmptyIndex
TopologyIndex
ModelIndex
InstanceIndex
TimeIndex
PositionIndex
VelocityIndex
DynamicsIndex
AccelerationIndex
ReportIndex

---

Member Function Documentation

Stage next

(

)

const [inline]

Stage prev

(

)

const [inline]

Referenced by Stage::invalidate().

void invalidate

(

Stage

tooHigh

)

[inline]

References Enumeration::getIndex(), and Stage::prev().

bool isInRuntimeRange

(

)

const [inline]

References Stage::HighestRuntime, and Stage::LowestRuntime.

---

Friends And Related Function Documentation

friend class Enumeration< Stage > [friend]

---

Member Data Documentation

const Stage Empty [static]

const Stage Topology [static]

Referenced by OLDRungeKuttaMerson::initialize(), OLDExplicitEuler::initialize(), OLDCPodesIntegrator::initialize(), OLDCPodesIntegrator::OLDCPodesIntegrator(), OLDExplicitEuler::OLDExplicitEuler(), and OLDRungeKuttaMerson::OLDRungeKuttaMerson().

const Stage Model [static]

Referenced by OLDRungeKuttaMerson::initialize(), OLDExplicitEuler::initialize(), and OLDCPodesIntegrator::initialize().

const Stage Instance [static]

Referenced by OLDRungeKuttaMerson::step(), OLDExplicitEuler::step(), and OLDCPodesIntegrator::step().

const Stage Time [static]

const Stage Position [static]

Referenced by PeriodicVmdReporter::handleEvent(), PeriodicPdbWriter::handleEvent(), OLDExplicitEuler::initialize(), CPodesMultibodySystem::project(), and OLDExplicitEuler::step().

const Stage Velocity [static]

Referenced by CPodesMultibodySystem::constraint(), OLDCPodesIntegrator::initialize(), and OLDExplicitEuler::step().

const Stage Dynamics [static]

const Stage Acceleration [static]

Referenced by CPodesMultibodySystem::explicitODE(), OLDExplicitEuler::initialize(), OLDRungeKuttaMerson::step(), and OLDExplicitEuler::step().

const Stage Report [static]

const Stage LowestValid [static]

const Stage HighestValid [static]

Referenced by SimTK::SimTK_DEFINE_UNIQUE_INDEX_TYPE().

const int NValid = ReportIndex-EmptyIndex+1 [static]

const Stage LowestRuntime [static]

Referenced by Stage::isInRuntimeRange().

const Stage HighestRuntime [static]

Referenced by Stage::isInRuntimeRange().

const int NRuntime = ReportIndex-ModelIndex+1 [static]

---

The documentation for this class was generated from the following file:

• Stage.h