Guts Class Reference

The abstract parent of all Subsystem "Guts" implementation classes. More...

#include <SubsystemGuts.h>

Inheritance diagram for Guts:
Guts

List of all members.

Public Member Functions

 Guts (const Guts &)
Gutsoperator= (const Guts &)
 Guts (const String &name="<NONAME>", const String &version="0.0.0")
virtual ~Guts ()
const StringgetName () const
const StringgetVersion () const
QIndex allocateQ (State &s, const Vector &qInit) const
UIndex allocateU (State &s, const Vector &uInit) const
ZIndex allocateZ (State &s, const Vector &zInit) const
DiscreteVariableIndex allocateDiscreteVariable (State &s, Stage g, AbstractValue *v) const
CacheEntryIndex allocateCacheEntry (const State &, Stage dependsOn, Stage computedBy, AbstractValue *v) const
CacheEntryIndex allocateCacheEntry (const State &state, Stage g, AbstractValue *v) const
QErrIndex allocateQErr (const State &s, int nqerr) const
UErrIndex allocateUErr (const State &s, int nuerr) const
UDotErrIndex allocateUDotErr (const State &s, int nudoterr) const
EventTriggerByStageIndex allocateEventTriggersByStage (const State &, Stage, int ntriggers) const
const VectorgetQ (const State &) const
const VectorgetU (const State &) const
const VectorgetZ (const State &) const
const VectorgetQDot (const State &) const
const VectorgetUDot (const State &) const
const VectorgetZDot (const State &) const
const VectorgetQDotDot (const State &) const
const VectorgetQErr (const State &) const
const VectorgetUErr (const State &) const
const VectorgetUDotErr (const State &) const
const VectorgetMultipliers (const State &) const
const VectorgetEventTriggersByStage (const State &, Stage) const
VectorupdQ (State &) const
VectorupdU (State &) const
VectorupdZ (State &) const
void setQ (State &s, const Vector &q) const
void setU (State &s, const Vector &u) const
void setZ (State &s, const Vector &z) const
VectorupdQDot (const State &) const
VectorupdUDot (const State &) const
VectorupdZDot (const State &) const
VectorupdQDotDot (const State &) const
VectorupdQErr (const State &) const
VectorupdUErr (const State &) const
VectorupdUDotErr (const State &) const
VectorupdMultipliers (const State &) const
VectorupdEventTriggersByStage (const State &, Stage) const
Stage getStage (const State &) const
const AbstractValuegetDiscreteVariable (const State &, DiscreteVariableIndex) const
AbstractValueupdDiscreteVariable (State &, DiscreteVariableIndex) const
const AbstractValuegetCacheEntry (const State &, CacheEntryIndex) const
AbstractValueupdCacheEntry (const State &, CacheEntryIndex) const
bool isCacheValueCurrent (const State &, CacheEntryIndex) const
void markCacheValueRealized (const State &, CacheEntryIndex) const
SystemQIndex getQStart (const State &) const
int getNQ (const State &) const
SystemUIndex getUStart (const State &) const
int getNU (const State &) const
SystemZIndex getZStart (const State &) const
int getNZ (const State &) const
SystemQErrIndex getQErrStart (const State &) const
int getNQErr (const State &) const
SystemUErrIndex getUErrStart (const State &) const
int getNUErr (const State &) const
SystemUDotErrIndex getUDotErrStart (const State &) const
int getNUDotErr (const State &) const
SystemMultiplierIndex getMultipliersStart (const State &) const
int getNMultipliers (const State &) const
SystemEventTriggerByStageIndex getEventTriggerStartByStage (const State &, Stage) const
int getNEventTriggersByStage (const State &, Stage) const
MeasureIndex adoptMeasure (Measure &m)
Measure getMeasure (MeasureIndex) const
template<class T >
Measure_< T > getMeasure_ (MeasureIndex mx) const
bool isInSystem () const
bool isInSameSystem (const Subsystem &otherSubsystem) const
const SystemgetSystem () const
SystemupdSystem ()
SubsystemIndex getMySubsystemIndex () const
const SubsystemgetOwnerSubsystemHandle () const
SubsystemupdOwnerSubsystemHandle ()
void setOwnerSubsystemHandle (Subsystem &)
bool hasOwnerSubsystemHandle () const
void setSystem (System &, SubsystemIndex)
 Guts (GutsRep *r)
bool hasRep () const
const GutsRep & getRep () const
GutsRep & updRep () const
void setRep (GutsRep &r)
bool subsystemTopologyHasBeenRealized () const
void invalidateSubsystemTopologyCache () const
Subsystem::Gutsclone () const
void realizeSubsystemTopology (State &) const
void realizeSubsystemModel (State &) const
void realizeSubsystemInstance (const State &) const
void realizeSubsystemTime (const State &) const
void realizeSubsystemPosition (const State &) const
void realizeSubsystemVelocity (const State &) const
void realizeSubsystemDynamics (const State &) const
void realizeSubsystemAcceleration (const State &) const
void realizeSubsystemReport (const State &) const
void calcQUnitWeights (const State &, Vector &weights) const
void calcUUnitWeights (const State &, Vector &weights) const
void calcZUnitWeights (const State &, Vector &weights) const
void calcQErrUnitTolerances (const State &, Vector &tolerances) const
void calcUErrUnitTolerances (const State &, Vector &tolerances) const
void calcDecorativeGeometryAndAppend (const State &, Stage, std::vector< DecorativeGeometry > &) const
void createScheduledEvent (const State &state, EventId &eventId) const
void createTriggeredEvent (const State &state, EventId &eventId, EventTriggerByStageIndex &triggerFunctionIndex, Stage stage) const
virtual void calcEventTriggerInfo (const State &, std::vector< System::EventTriggerInfo > &) const
virtual void calcTimeOfNextScheduledEvent (const State &, Real &tNextEvent, std::vector< EventId > &eventIds, bool includeCurrentTime) const
virtual void calcTimeOfNextScheduledReport (const State &, Real &tNextEvent, std::vector< EventId > &eventIds, bool includeCurrentTime) const
virtual void handleEvents (State &, Event::Cause, const std::vector< EventId > &eventIds, Real accuracy, const Vector &yWeights, const Vector &ooConstraintTols, Stage &lowestModified, bool &shouldTerminate) const
virtual void reportEvents (const State &, Event::Cause, const std::vector< EventId > &eventIds) const

Protected Member Functions

virtual Subsystem::GutscloneImpl () const =0
virtual int realizeSubsystemTopologyImpl (State &s) const
virtual int realizeSubsystemModelImpl (State &s) const
virtual int realizeSubsystemInstanceImpl (const State &s) const
virtual int realizeSubsystemTimeImpl (const State &s) const
virtual int realizeSubsystemPositionImpl (const State &s) const
virtual int realizeSubsystemVelocityImpl (const State &s) const
virtual int realizeSubsystemDynamicsImpl (const State &s) const
virtual int realizeSubsystemAccelerationImpl (const State &s) const
virtual int realizeSubsystemReportImpl (const State &s) const
virtual int calcQUnitWeightsImpl (const State &s, Vector &weights) const
virtual int calcUUnitWeightsImpl (const State &s, Vector &weights) const
virtual int calcZUnitWeightsImpl (const State &s, Vector &weights) const
virtual int calcQErrUnitTolerancesImpl (const State &s, Vector &tolerances) const
virtual int calcUErrUnitTolerancesImpl (const State &s, Vector &tolerances) const
virtual int calcDecorativeGeometryAndAppendImpl (const State &, Stage, std::vector< DecorativeGeometry > &) const
void advanceToStage (const State &s, Stage g) const

Friends

class GutsRep

Detailed Description

The abstract parent of all Subsystem "Guts" implementation classes.


Constructor & Destructor Documentation

Guts ( const Guts  ) 
Guts ( const String name = "<NONAME>",
const String version = "0.0.0" 
) [explicit]

Reimplemented in Guts.

virtual ~Guts (  )  [virtual]

Reimplemented in Guts.

Guts ( GutsRep *  r  )  [inline, explicit]

Member Function Documentation

MeasureIndex adoptMeasure ( Measure m  ) 
void advanceToStage ( const State s,
Stage  g 
) const [protected]
CacheEntryIndex allocateCacheEntry ( const State state,
Stage  g,
AbstractValue v 
) const [inline]
CacheEntryIndex allocateCacheEntry ( const State ,
Stage  dependsOn,
Stage  computedBy,
AbstractValue v 
) const
DiscreteVariableIndex allocateDiscreteVariable ( State s,
Stage  g,
AbstractValue v 
) const
EventTriggerByStageIndex allocateEventTriggersByStage ( const State ,
Stage  ,
int  ntriggers 
) const
QIndex allocateQ ( State s,
const Vector qInit 
) const
QErrIndex allocateQErr ( const State s,
int  nqerr 
) const
UIndex allocateU ( State s,
const Vector uInit 
) const
UDotErrIndex allocateUDotErr ( const State s,
int  nudoterr 
) const
UErrIndex allocateUErr ( const State s,
int  nuerr 
) const
ZIndex allocateZ ( State s,
const Vector zInit 
) const
void calcDecorativeGeometryAndAppend ( const State ,
Stage  ,
std::vector< DecorativeGeometry > &   
) const
virtual int calcDecorativeGeometryAndAppendImpl ( const State ,
Stage  ,
std::vector< DecorativeGeometry > &   
) const [protected, virtual]
virtual void calcEventTriggerInfo ( const State ,
std::vector< System::EventTriggerInfo > &   
) const [virtual]
void calcQErrUnitTolerances ( const State ,
Vector tolerances 
) const
virtual int calcQErrUnitTolerancesImpl ( const State s,
Vector tolerances 
) const [protected, virtual]
void calcQUnitWeights ( const State ,
Vector weights 
) const
virtual int calcQUnitWeightsImpl ( const State s,
Vector weights 
) const [protected, virtual]
virtual void calcTimeOfNextScheduledEvent ( const State ,
Real &  tNextEvent,
std::vector< EventId > &  eventIds,
bool  includeCurrentTime 
) const [virtual]
virtual void calcTimeOfNextScheduledReport ( const State ,
Real &  tNextEvent,
std::vector< EventId > &  eventIds,
bool  includeCurrentTime 
) const [virtual]
void calcUErrUnitTolerances ( const State ,
Vector tolerances 
) const
virtual int calcUErrUnitTolerancesImpl ( const State s,
Vector tolerances 
) const [protected, virtual]
void calcUUnitWeights ( const State ,
Vector weights 
) const
virtual int calcUUnitWeightsImpl ( const State s,
Vector weights 
) const [protected, virtual]
void calcZUnitWeights ( const State ,
Vector weights 
) const
virtual int calcZUnitWeightsImpl ( const State s,
Vector weights 
) const [protected, virtual]
Subsystem::Guts* clone (  )  const
virtual Subsystem::Guts* cloneImpl (  )  const [protected, pure virtual]
void createScheduledEvent ( const State state,
EventId &  eventId 
) const
void createTriggeredEvent ( const State state,
EventId &  eventId,
EventTriggerByStageIndex &  triggerFunctionIndex,
Stage  stage 
) const
const AbstractValue& getCacheEntry ( const State ,
CacheEntryIndex   
) const
const AbstractValue& getDiscreteVariable ( const State ,
DiscreteVariableIndex   
) const
const Vector& getEventTriggersByStage ( const State ,
Stage   
) const
SystemEventTriggerByStageIndex getEventTriggerStartByStage ( const State ,
Stage   
) const
Measure getMeasure ( MeasureIndex   )  const
Measure_<T> getMeasure_ ( MeasureIndex  mx  )  const [inline]
const Vector& getMultipliers ( const State  )  const
SystemMultiplierIndex getMultipliersStart ( const State  )  const
SubsystemIndex getMySubsystemIndex (  )  const
const String& getName (  )  const
int getNEventTriggersByStage ( const State ,
Stage   
) const
int getNMultipliers ( const State  )  const
int getNQ ( const State  )  const
int getNQErr ( const State  )  const
int getNU ( const State  )  const
int getNUDotErr ( const State  )  const
int getNUErr ( const State  )  const
int getNZ ( const State  )  const
const Subsystem& getOwnerSubsystemHandle (  )  const
const Vector& getQ ( const State  )  const
const Vector& getQDot ( const State  )  const
const Vector& getQDotDot ( const State  )  const
const Vector& getQErr ( const State  )  const
SystemQErrIndex getQErrStart ( const State  )  const
SystemQIndex getQStart ( const State  )  const
const GutsRep& getRep (  )  const [inline]
Stage getStage ( const State  )  const
const System& getSystem (  )  const
const Vector& getU ( const State  )  const
const Vector& getUDot ( const State  )  const
const Vector& getUDotErr ( const State  )  const
SystemUDotErrIndex getUDotErrStart ( const State  )  const
const Vector& getUErr ( const State  )  const
SystemUErrIndex getUErrStart ( const State  )  const
SystemUIndex getUStart ( const State  )  const
const String& getVersion (  )  const
const Vector& getZ ( const State  )  const
const Vector& getZDot ( const State  )  const
SystemZIndex getZStart ( const State  )  const
virtual void handleEvents ( State ,
Event::Cause  ,
const std::vector< EventId > &  eventIds,
Real  accuracy,
const Vector yWeights,
const Vector ooConstraintTols,
Stage lowestModified,
bool &  shouldTerminate 
) const [virtual]
bool hasOwnerSubsystemHandle (  )  const
bool hasRep (  )  const [inline]
void invalidateSubsystemTopologyCache (  )  const
bool isCacheValueCurrent ( const State ,
CacheEntryIndex   
) const
bool isInSameSystem ( const Subsystem otherSubsystem  )  const
bool isInSystem (  )  const
void markCacheValueRealized ( const State ,
CacheEntryIndex   
) const
Guts& operator= ( const Guts  ) 
void realizeSubsystemAcceleration ( const State  )  const
virtual int realizeSubsystemAccelerationImpl ( const State s  )  const [protected, virtual]
void realizeSubsystemDynamics ( const State  )  const
virtual int realizeSubsystemDynamicsImpl ( const State s  )  const [protected, virtual]
void realizeSubsystemInstance ( const State  )  const
virtual int realizeSubsystemInstanceImpl ( const State s  )  const [protected, virtual]
void realizeSubsystemModel ( State  )  const
virtual int realizeSubsystemModelImpl ( State s  )  const [protected, virtual]
void realizeSubsystemPosition ( const State  )  const
virtual int realizeSubsystemPositionImpl ( const State s  )  const [protected, virtual]
void realizeSubsystemReport ( const State  )  const
virtual int realizeSubsystemReportImpl ( const State s  )  const [protected, virtual]
void realizeSubsystemTime ( const State  )  const
virtual int realizeSubsystemTimeImpl ( const State s  )  const [protected, virtual]
void realizeSubsystemTopology ( State  )  const
virtual int realizeSubsystemTopologyImpl ( State s  )  const [protected, virtual]
void realizeSubsystemVelocity ( const State  )  const
virtual int realizeSubsystemVelocityImpl ( const State s  )  const [protected, virtual]
virtual void reportEvents ( const State ,
Event::Cause  ,
const std::vector< EventId > &  eventIds 
) const [virtual]
void setOwnerSubsystemHandle ( Subsystem  ) 
void setQ ( State s,
const Vector q 
) const [inline]
void setRep ( GutsRep &  r  )  [inline]
void setSystem ( System ,
SubsystemIndex   
)
void setU ( State s,
const Vector u 
) const [inline]
void setZ ( State s,
const Vector z 
) const [inline]
bool subsystemTopologyHasBeenRealized (  )  const
AbstractValue& updCacheEntry ( const State ,
CacheEntryIndex   
) const
AbstractValue& updDiscreteVariable ( State ,
DiscreteVariableIndex   
) const
Vector& updEventTriggersByStage ( const State ,
Stage   
) const
Vector& updMultipliers ( const State  )  const
Subsystem& updOwnerSubsystemHandle (  ) 
Vector& updQ ( State  )  const
Vector& updQDot ( const State  )  const
Vector& updQDotDot ( const State  )  const
Vector& updQErr ( const State  )  const
GutsRep& updRep (  )  const [inline]
System& updSystem (  ) 
Vector& updU ( State  )  const
Vector& updUDot ( const State  )  const
Vector& updUDotErr ( const State  )  const
Vector& updUErr ( const State  )  const
Vector& updZ ( State  )  const
Vector& updZDot ( const State  )  const

Friends And Related Function Documentation

friend class GutsRep [friend]

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

Generated by  doxygen 1.6.2