Subsystem Class Reference

#include <Subsystem.h>

Inheritance diagram for Subsystem:

List of all members.

---

Detailed Description

The abstract parent of all Subsystems.

A Subsystem is expected to be part of a larger System and to have interdependencies with other subsystems of that same system. It must NOT have dependencies on objects which are outside the System. Consequently construction of any concrete subsystem requires specification of a system at that time. Subsystems go through an extended construction phase in which their contents and interdependencies are created. Thus all of a System's Subsystems generally need to be available simultaneously during construction, so that they can reference each other.

There are three distinct users of this class:

• the System class
• the concrete Subsystems derived from this class
• the end user of a concrete Subsystem Only end user methods are public here. Methods intended for use by the concrete Subsystem class can be found in the Subsystem::Guts class which is defined in a separate header file. End users need not look over there -- trust me, you'll find it disturbing if you do!

Public Member Functions
	Subsystem ()
	Subsystem (const Subsystem &)
Subsystem &	operator= (const Subsystem &)
	~Subsystem ()
const String &	getName () const
const String &	getVersion () const
const Vector &	getQ (const State &) const
const Vector &	getU (const State &) const
const Vector &	getZ (const State &) const
const Vector &	getQDot (const State &) const
const Vector &	getUDot (const State &) const
const Vector &	getZDot (const State &) const
const Vector &	getQDotDot (const State &) const
const Vector &	getQErr (const State &) const
const Vector &	getUErr (const State &) const
const Vector &	getUDotErr (const State &) const
const Vector &	getMultipliers (const State &) const
Vector &	updQ (State &) const
Vector &	updU (State &) const
Vector &	updZ (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
Vector &	updQDot (const State &) const
Vector &	updUDot (const State &) const
Vector &	updZDot (const State &) const
Vector &	updQDotDot (const State &) const
Vector &	updQErr (const State &) const
Vector &	updUErr (const State &) const
Vector &	updUDotErr (const State &) const
Vector &	updMultipliers (const State &) const
Stage	getStage (const State &) const
const AbstractValue &	getDiscreteVariable (const State &, int index) const
AbstractValue &	updDiscreteVariable (State &, int index) const
const AbstractValue &	getCacheEntry (const State &, int index) const
AbstractValue &	updCacheEntry (const State &, int index) const
int	getQStart (const State &) const
int	getNQ (const State &) const
int	getUStart (const State &) const
int	getNU (const State &) const
int	getZStart (const State &) const
int	getNZ (const State &) const
int	getQErrStart (const State &) const
int	getNQErr (const State &) const
int	getUErrStart (const State &) const
int	getNUErr (const State &) const
int	getUDotErrStart (const State &) const
int	getNUDotErr (const State &) const
int	getMultipliersStart (const State &) const
int	getNMultipliers (const State &) const
bool	isInSystem () const
bool	isInSameSystem (const Subsystem &otherSubsystem) const
const System &	getSystem () const
System &	updSystem ()
SubsystemIndex	getMySubsystemIndex () const
bool	isOwnerHandle () const
bool	isEmptyHandle () const
bool	isSameSubsystem (const Subsystem &otherSubsystem) const
bool	subsystemTopologyHasBeenRealized () const
void	invalidateSubsystemTopologyCache () const
const Subsystem::Guts &	getSubsystemGuts () const
Subsystem::Guts &	updSubsystemGuts ()
void	adoptSubsystemGuts (Subsystem::Guts *g)
void	setSystem (System &, SubsystemIndex)
	Subsystem (Subsystem::Guts *g)
bool	hasGuts () const
Friends
class	Guts
Classes
class	Guts
	The abstract parent of all Subsystems. More...

---

Constructor & Destructor Documentation

Subsystem

(

)

[inline]

Subsystem

(

const Subsystem &

)

~Subsystem

(

)

Subsystem

(

Subsystem::Guts *

g

)

[inline, explicit]

---

Member Function Documentation

void adoptSubsystemGuts

(

Subsystem::Guts *

g

)

const AbstractValue& getCacheEntry	(	const State &	,
		int	index
	)			const

const AbstractValue& getDiscreteVariable	(	const State &	,
		int	index
	)			const

const Vector& getMultipliers

(

const State &

)

const

int getMultipliersStart

(

const State &

)

const

SubsystemIndex getMySubsystemIndex

(

)

const

const String& getName

(

)

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 Vector& getQ

(

const State &

)

const

const Vector& getQDot

(

const State &

)

const

const Vector& getQDotDot

(

const State &

)

const

const Vector& getQErr

(

const State &

)

const

int getQErrStart

(

const State &

)

const

int getQStart

(

const State &

)

const

Stage getStage

(

const State &

)

const

const Subsystem::Guts& getSubsystemGuts

(

)

const [inline]

const System& getSystem

(

)

const

const Vector& getU

(

const State &

)

const

const Vector& getUDot

(

const State &

)

const

const Vector& getUDotErr

(

const State &

)

const

int getUDotErrStart

(

const State &

)

const

const Vector& getUErr

(

const State &

)

const

int getUErrStart

(

const State &

)

const

int getUStart

(

const State &

)

const

const String& getVersion

(

)

const

const Vector& getZ

(

const State &

)

const

const Vector& getZDot

(

const State &

)

const

int getZStart

(

const State &

)

const

bool hasGuts

(

)

const [inline]

void invalidateSubsystemTopologyCache

(

)

const

bool isEmptyHandle

(

)

const

bool isInSameSystem

(

const Subsystem &

otherSubsystem

)

const

bool isInSystem

(

)

const

bool isOwnerHandle

(

)

const

bool isSameSubsystem

(

const Subsystem &

otherSubsystem

)

const

Subsystem& operator=

(

const Subsystem &

)

void setQ	(	State &	s,
		const Vector &	q
	)			const [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 &	,
		int	index
	)			const

AbstractValue& updDiscreteVariable	(	State &	,
		int	index
	)			const

Vector& updMultipliers

(

const State &

)

const

Vector& updQ

(

State &

)

const

Vector& updQDot

(

const State &

)

const

Vector& updQDotDot

(

const State &

)

const

Vector& updQErr

(

const State &

)

const

Subsystem::Guts& updSubsystemGuts

(

)

[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 Guts [friend]

---

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

• Subsystem.h

---