ptolemy.domains.modal.kernel
Class Configurer.ContainmentExtender

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.domains.modal.kernel.Configurer.ContainmentExtender

All Implemented Interfaces:

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

Enclosing class:

Configurer

public static class Configurer.ContainmentExtender
extends Attribute
implements ContainmentExtender

The containment extender that returns the configured object as the container of this configurer.

Since:

Ptolemy II 8.0

Version:

$Id: Configurer.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

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

Configurer.ContainmentExtender(Configurer container, java.lang.String name)
Construct a containment extender.

Method Summary

NamedObj	getContainedObject(java.lang.String name) Get an object with the given name within the container.
NamedObj	getExtendedContainer() Get the extended container.

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

Constructor Detail

Configurer.ContainmentExtender

public Configurer.ContainmentExtender(Configurer container,
                                      java.lang.String name)
                               throws IllegalActionException,
                                      NameDuplicationException

Construct a containment extender.

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.

Method Detail

getContainedObject

public NamedObj getContainedObject(java.lang.String name)
                            throws IllegalActionException

Get an object with the given name within the container.

Specified by:

getContainedObject in interface ContainmentExtender

Parameters:

name - The name of the object.

Returns:

The object, or null if not found.

Throws:

IllegalActionException - If exception occurs when trying to get the contained object.

getExtendedContainer

public NamedObj getExtendedContainer()
                              throws IllegalActionException

Get the extended container.

Specified by:

getExtendedContainer in interface ContainmentExtender

Returns:

The container.

Throws:

IllegalActionException - If exception occurs when trying to get the container.