This is the base class for all Measure handle classes. More...
#include <Measure.h>
Classes | |
class | Constant_ |
This creates a Measure whose value is a Topology-stage constant of any type T. More... | |
class | Implementation |
The abstract parent of all Measure_ Implementation classes. More... | |
class | Integrate_ |
class | Minimum_ |
This Measure tracks the minimum value attained by its source operand since the last initialize() call. More... | |
class | SampleAndHold_ |
This is a Measure operator which, upon occurrence of a designated event, samples its source Measure and then holds its value in a discrete state variable until the next occurrence of the event. More... | |
class | SetHandle |
class | Sinusoid_ |
This measure produces a sinusoidal function of time: m(t) = a*sin(w*t+p) where a=amplitude in arbitrary units, w=frequency in rad/s, p=phase in rad. More... | |
Public Types | |
typedef Constant_< Real > | Constant |
typedef Integrate_< Real > | Integrate |
typedef Sinusoid_< Real > | Sinusoid |
Public Member Functions | |
Measure (Implementation *g=0) | |
Measure (Subsystem &, Implementation *g, const SetHandle &) | |
Measure (const Measure &) | |
Measure & | operator= (const Measure &) |
~Measure () | |
Stage | getValueDependence (const State &) const |
bool | isSameMeasure (const Measure &other) const |
bool | isInSubsystem () const |
const Subsystem & | getSubsystem () const |
MeasureIndex | getSubsystemMeasureIndex () const |
const Implementation & | getImpl () const |
Implementation & | updImpl () |
bool | hasImpl () const |
Friends | |
class | Implementation |
This is the base class for all Measure handle classes.
This class is not templatized, and represents a Measure generically without knowledge of its value type. This is useful for most of the basic operations that are performed on measures, such as realization, adoption by a Subsystem, and other bookkeeping tasks. For most user purposes, the still-generic derived class Measure_<T> is a more useful handle since its value, of known type T, can be obtained. All the built-in concrete Measure types derive from Measure_<T> rather than Measure. The various concrete Measures, built in or otherwise, may set restrictions on the kinds of types that are allowable as the template argument.
Note that handles always consist of exactly one pointer, and handle classes are always concrete (meaning they have no virtual methods).
typedef Integrate_<Real> Integrate |
Measure | ( | Implementation * | g = 0 |
) | [inline, explicit] |
Measure | ( | Subsystem & | sub, | |
Implementation * | g, | |||
const SetHandle & | ||||
) | [inline] |
References Implementation::incrRefCount().
~Measure | ( | ) | [inline] |
const Implementation& getImpl | ( | ) | const [inline] |
const Subsystem & getSubsystem | ( | ) | const [inline] |
References Implementation::decrRefCount().
Referenced by Implementation::getDerivativeMeasure(), and Implementation::initializeImpl().
MeasureIndex getSubsystemMeasureIndex | ( | ) | const [inline] |
References Implementation::isInSubsystem().
References Implementation::getSubsystemMeasureIndex().
bool hasImpl | ( | ) | const [inline] |
bool isInSubsystem | ( | ) | const [inline] |
bool isSameMeasure | ( | const Measure & | other | ) | const [inline] |
Implementation& updImpl | ( | ) | [inline] |
friend class Implementation [friend] |