org.kepler.monitor

Class MonitorAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.SingletonAttribute

org.kepler.monitor.MonitorAttribute

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Singleton

public class MonitorAttribute
extends SingletonAttribute

An instance of this class is automatically added by the monitor manager for each entity to be monitored.

This attribute contains a MonitorIcon.

Author:

Carlos Rueda

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	iconType
StringParameter	timerDelay

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

Constructor Summary

Constructors

Constructor and Description
MonitorAttribute(NamedObj container, java.lang.String name) Creates a monitor attribute.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) Do updates according to the changed attribute.
FigureUpdater	getFigureUpdater()
MonitorIcon	getIcon()
IOPort	getPort()
void	setContainer(NamedObj container) If this component is removed from its container, finish monitoring
void	setFigureUpdater(FigureUpdater updater)
void	setMonitoredStatus(MonitoredStatus status)
void	setPort(IOPort port)

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

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

Field Detail

iconType

public StringParameter iconType

timerDelay

public StringParameter timerDelay

Constructor Detail

MonitorAttribute

public MonitorAttribute(NamedObj container,
                        java.lang.String name)
                 throws IllegalActionException,
                        NameDuplicationException

Creates a monitor attribute.

Throws:

IllegalActionException

NameDuplicationException

Method Detail

setMonitoredStatus

public void setMonitoredStatus(MonitoredStatus status)

setFigureUpdater

public void setFigureUpdater(FigureUpdater updater)

Parameters:

updater - the FigureUpdater to set

getFigureUpdater

public FigureUpdater getFigureUpdater()

getPort

public IOPort getPort()

Returns:

the IOPort. null by default.

setPort

public void setPort(IOPort port)

Parameters:

port - the IOPort to set

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Do updates according to the changed attribute.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

If this component is removed from its container, finish monitoring

Overrides:

setContainer in class SingletonAttribute

Parameters:

container - The container to attach this attribute to.

Throws:

IllegalActionException - If this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment.

NameDuplicationException - If the container already has an attribute with the name of this attribute that is of class SingletonConfigurableAttribute.

See Also:

Attribute.getContainer()

getIcon

public MonitorIcon getIcon()