org.kepler.monitor

Class MonitorManager

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.SingletonAttribute

org.kepler.monitor.MonitorManager

All Implemented Interfaces:

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

public class MonitorManager
extends SingletonAttribute
implements Initializable

The monitor manager.

An instance of this attribute can be inserted in a workflow to dynamically associate activity icons to the existing entities ( ComponentEntity).

Demo workflows are under $KEPLER/workflows/test/monitor/

Note: Configuration is very limited in this preliminary version.

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
Parameter	addInputPortCounters Add monitor attributes for input ports?
Parameter	addOutputPortCounters Add monitor attributes for output ports?
StringParameter	iconType The icon type for all created monitor attributes
StringParameter	timerDelay Delay for the timer

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
MonitorManager(NamedObj container, java.lang.String name) Creates a monitor manager.

Method Summary

Modifier and Type	Method and Description
void	addInitializable(Initializable initializable) Does nothing.
void	attributeChanged(Attribute attribute) Sets the icon type and timer delay according to the changed attribute.
void	initialize() Creates the MI attributes for the existing component entities in the container and activates the MI icons.
void	preinitialize() Does nothing.
void	removeInitializable(Initializable initializable) Does nothing.
void	setContainer(NamedObj container) If container is null, it finishes monitoring
void	wrapup() Finishes the monitors.

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

The icon type for all created monitor attributes

timerDelay

public StringParameter timerDelay

Delay for the timer

addInputPortCounters

public Parameter addInputPortCounters

Add monitor attributes for input ports?

addOutputPortCounters

public Parameter addOutputPortCounters

Add monitor attributes for output ports?

Constructor Detail

MonitorManager

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

Creates a monitor manager.

Throws:

IllegalActionException

NameDuplicationException

See Also:

SingletonAttribute.SingletonAttribute(NamedObj, String)

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Sets the icon type and timer delay 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).

wrapup

public void wrapup()
            throws IllegalActionException

Finishes the monitors.

Specified by:

wrapup in interface Initializable

Throws:

IllegalActionException - If wrapup is not permitted.

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

If container is null, it finishes 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()

initialize

public void initialize()
                throws IllegalActionException

Creates the MI attributes for the existing component entities in the container and activates the MI icons.

Specified by:

initialize in interface Initializable

Throws:

IllegalActionException - If execution is not permitted.

addInitializable

public void addInitializable(Initializable initializable)

Does nothing.

Specified by:

addInitializable in interface Initializable

Parameters:

initializable - The object whose methods should be invoked.

See Also:

Initializable.removeInitializable(Initializable)

preinitialize

public void preinitialize()
                   throws IllegalActionException

Does nothing.

Specified by:

preinitialize in interface Initializable

Throws:

IllegalActionException - If initializing is not permitted.

removeInitializable

public void removeInitializable(Initializable initializable)

Does nothing.

Specified by:

removeInitializable in interface Initializable

Parameters:

initializable - The object whose methods should no longer be invoked.

See Also:

Initializable.addInitializable(Initializable)