Package org.ptolemy.ssm

Class MeasurementModel

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

org.ptolemy.ssm.MirrorDecorator

org.ptolemy.ssm.MeasurementModel

All Implemented Interfaces:

java.lang.Cloneable, StateSpaceActor, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Decorator, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

GaussianMeasurementModel

public abstract class MeasurementModel
extends MirrorDecorator
implements StateSpaceActor

An abstract decorator that defines a measurement model.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Ilge Akkaya

Pt.AcceptedRating:

Pt.ProposedRating:

Red (ilgea)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
TypedIOPort	z	The measurement equation that will refer to the state space model.
Parameter	zParameter	The measurement port.

Fields inherited from class org.ptolemy.ssm.MirrorDecorator

_addedParameters, _addedPortNames, _addedPortParameterNames, _decoratedObjects, _decoratedObjectsVersion, _listeners

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor	Description
MeasurementModel(CompositeEntity container, java.lang.String name)	Constructs a MeasurementModel object.

Method Summary

Modifier and Type	Method	Description
DecoratorAttributes	createDecoratorAttributes(NamedObj target)	Create and return the decorated attributes for the target NamedObj.
java.util.List<NamedObj>	decoratedObjects()	Return the decorated objects.
java.lang.String	getMeasurementParameterPostfix()	Return the measurement postfix.
boolean	validDecoratorAssociationExists()	Return true if a valid decorator association exists.

Methods inherited from class org.ptolemy.ssm.MirrorDecorator

_addAttribute, _addPort, _removeAttribute, _removePort, attributeChanged, clone, getAddedParameters, getAddedPortNames, getAddedPortParameterNames, isGlobalDecorator, registerListener, sendParameterEvent, sendPortEvent, setContainer

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_description, _exportMoMLContents, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

fire, isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Field Detail

z

public TypedIOPort z

The measurement equation that will refer to the state space model.

zParameter

public Parameter zParameter

The measurement port.

Constructor Detail

MeasurementModel

public MeasurementModel(CompositeEntity container,
                        java.lang.String name)
                 throws IllegalActionException,
                        NameDuplicationException

Constructs a MeasurementModel object.

Parameters:

container - a CompositeEntity object

name - a String indicating the decorator name

Throws:

IllegalActionException

NameDuplicationException

Method Detail

createDecoratorAttributes

public DecoratorAttributes createDecoratorAttributes(NamedObj target)

Description copied from interface: Decorator

Create and return the decorated attributes for the target NamedObj. Implementations of this method should create an Attribute that implements DecoratorAttributes. Implementations should populate that attribute with parameters that have appropriate default values.

This method is called if NamedObj.getDecoratorAttribute(Decorator, String) or NamedObj.getDecoratorAttributes(Decorator) is called, and the specified target object does not already have decorated attributes for this decorator.

The implementer of this method is responsible for ensuring consistency with the Decorator.decoratedObjects() method. Specifically, any object returned by Decorator.decoratedObjects(), when passed as an argument to this method, should not result in a null returned value. And conversely, any object passed to this method that is not in the list returned by decoratedObjects() should result in a null returned value.

Specified by:

createDecoratorAttributes in interface Decorator

Overrides:

createDecoratorAttributes in class MirrorDecorator

Parameters:

target - The NamedObj that will be decorated.

Returns:

The decorated attributes for the target NamedObj, or null if the specified NamedObj is not decorated by this decorator.

decoratedObjects

public java.util.List<NamedObj> decoratedObjects()
                                          throws IllegalActionException

Description copied from class: MirrorDecorator

Return the decorated objects.

Specified by:

decoratedObjects in interface Decorator

Overrides:

decoratedObjects in class MirrorDecorator

Returns:

The decorated objects.

Throws:

IllegalActionException - If some object cannot be determined to be decorated or not (e.g., a parameter cannot be evaluated).

validDecoratorAssociationExists

public boolean validDecoratorAssociationExists()
                                        throws IllegalActionException

Description copied from interface: StateSpaceActor

Return true if a valid decorator association exists.

Specified by:

validDecoratorAssociationExists in interface StateSpaceActor

Returns:

true if a valid decorator association exists.

Throws:

IllegalActionException

getMeasurementParameterPostfix

public java.lang.String getMeasurementParameterPostfix()

Return the measurement postfix.

Returns:

the measurement postfix, which in this class is the string "Parameter".