ptolemy.actor

Class ExecutionAttributes

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.DecoratorAttributes

ptolemy.actor.ExecutionAttributes

All Implemented Interfaces:

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

Direct Known Subclasses:

CommunicationAspectAttributes, ExecutionTimeAttributes

public class ExecutionAttributes
extends DecoratorAttributes

Container for decorator attributes that are provided to actors by a ExecutionAspect. The resource scheduler decorates actors in a model with the attributes contained by this object. This provides an "enable" attribute.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Patricia Derler, Edward A. Lee

Pt.AcceptedRating:

Red (eal)

Pt.ProposedRating:

Yellow (eal)

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	enable The enable parameter specifies whether the decorated actor uses the resource scheduler decorator.

Fields inherited from class ptolemy.kernel.util.DecoratorAttributes

_decorator, decoratorName

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
ExecutionAttributes(NamedObj target, Decorator decorator) Constructor to use when editing a model.
ExecutionAttributes(NamedObj target, java.lang.String name) Constructor to use when parsing a MoML file.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) React to a change in an attribute.
boolean	enabled() Return whether the decorator associated with this attribute is enabled.

Methods inherited from class ptolemy.kernel.util.DecoratorAttributes

clone, exportMoML, getDecorator

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, 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, 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

enable

public Parameter enable

The enable parameter specifies whether the decorated actor uses the resource scheduler decorator. This is a boolean that defaults to false.

Constructor Detail

ExecutionAttributes

public ExecutionAttributes(NamedObj target,
                           Decorator decorator)
                    throws IllegalActionException,
                           NameDuplicationException

Constructor to use when editing a model.

Parameters:

target - The object being decorated.

decorator - The decorator.

Throws:

IllegalActionException - If the superclass throws it.

NameDuplicationException - If the superclass throws it.

ExecutionAttributes

public ExecutionAttributes(NamedObj target,
                           java.lang.String name)
                    throws IllegalActionException,
                           NameDuplicationException

Constructor to use when parsing a MoML file.

Parameters:

target - The object being decorated.

name - The name of this attribute.

Throws:

IllegalActionException - If the superclass throws it.

NameDuplicationException - If the superclass throws it.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute. If the attribute is enable, remember the value.

Overrides:

attributeChanged in class DecoratorAttributes

Parameters:

attribute - The attribute that changed.

Throws:

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

enabled

public boolean enabled()

Return whether the decorator associated with this attribute is enabled.

Returns:

True if enabled.