ptolemy.domains.modal.modal
Class RefinementExtender

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.domains.modal.modal.RefinementExtender

All Implemented Interfaces:

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

public class RefinementExtender
extends Attribute

An attribute to add a class to the list of refinement classes for a state. The name of this attribute should be an easy-to-remember name of the refinement class to be shown to the user in the dialog displayed when the user chooses to add a refinement. The className property of this attribute refers to the actual class, which is either a Java class with which the refinement is to be created, or a Ptolemy class specified in MoML at the path pointed to by the class name.

Since:

Ptolemy II 8.0

Version:

$Id: RefinementExtender.java 57044 2010-01-27 22:41:05Z cxh $

Author:

Thomas Huining Feng

See Also:

Serialized Form

Accepted Rating:

Red (tfeng)

Proposed Rating:

Red (tfeng)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

StringParameter	className The full name of the refinement class.
StringParameter	description A string description of the refinement class, which is shown in the dialog for the user to choose a refinement to add.

Fields inherited from class ptolemy.kernel.util.NamedObj

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

Constructor Summary

RefinementExtender(NamedObj container, java.lang.String name)
Construct a refinement extender attribute with the given name contained by the specified entity.

Method Summary

Methods inherited from class ptolemy.kernel.util.Attribute

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, 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, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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

className

public StringParameter className

The full name of the refinement class.

description

public StringParameter description

A string description of the refinement class, which is shown in the dialog for the user to choose a refinement to add.

Constructor Detail

RefinementExtender

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

Construct a refinement extender attribute with the given name contained by the specified entity. The container argument must not be null, or a NullPointerException will be thrown. This attribute will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.

Parameters:

container - The container.

name - The name of this attribute.

Throws:

IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.

NameDuplicationException - If the name coincides with an attribute already in the container.