org.kepler.sms

Class KeplerIOPortReference

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

org.kepler.sms.KeplerIOPortReference

All Implemented Interfaces:

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

Direct Known Subclasses:

KeplerVirtualIOPortReference

public class KeplerIOPortReference
extends StringAttribute

An IO Port Reference refers to a ptolemy Port within its containing entity. The port is referenced by name within the context of the entity (actor).

Author:

Shawn Bowers

See Also:

Port

Created:

June 14, 2005

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Nested classes/interfaces inherited from interface ptolemy.kernel.util.Settable

Settable.Visibility

Field Summary

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

Fields inherited from interface ptolemy.kernel.util.Settable

EXPERT, FULL, NONE, NOT_EDITABLE

Constructor Summary

Constructors

Constructor and Description
KeplerIOPortReference() Constructor
KeplerIOPortReference(NamedObj container, java.lang.String name) Constructor
KeplerIOPortReference(Workspace workspace) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) References are equal when they refer to the same port.
java.lang.String	getDefaultExpression() Return the default expression which is null
java.lang.Object	getPort() Return the corresponding IOPort for the reference.
Settable.Visibility	getVisibility() Set visibility to NOT_EDITABLE
void	setPort(IOPort port) Create a reference from the given port.
void	setVisibility(Settable.Visibility visibility) The visibility cannot be changed.
java.util.Collection	validate() Validate the expression.

Methods inherited from class ptolemy.kernel.util.StringAttribute

_propagateValue, addValueListener, clone, exportMoML, getExpression, removeValueListener, setExpression

Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute

getValueAsString

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, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, 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

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

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getFullName, getName, getName, setName

Constructor Detail

KeplerIOPortReference

public KeplerIOPortReference()

Constructor

KeplerIOPortReference

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

Constructor

Parameters:

container - Description of the Parameter

name - The value of the property

Throws:

IllegalActionException - Description of the Exception

NameDuplicationException - Description of the Exception

KeplerIOPortReference

public KeplerIOPortReference(Workspace workspace)

Constructor

Parameters:

workspace - Description of the Parameter

Method Detail

getDefaultExpression

public java.lang.String getDefaultExpression()

Return the default expression which is null

Specified by:

getDefaultExpression in interface Settable

Overrides:

getDefaultExpression in class AbstractSettableAttribute

Returns:

The defaultExpression value. Currently if not given, then unknown.

See Also:

AbstractSettableAttribute.setExpression(String), Instantiable

getPort

public java.lang.Object getPort()

Return the corresponding IOPort for the reference.

Returns:

The IOPort referred to by this reference.

setPort

public void setPort(IOPort port)
             throws IllegalActionException

Create a reference from the given port.

Parameters:

port - The port that this reference refers to

Throws:

IllegalActionException

getVisibility

public Settable.Visibility getVisibility()

Set visibility to NOT_EDITABLE

Specified by:

getVisibility in interface Settable

Overrides:

getVisibility in class StringAttribute

Returns:

The visibility value

See Also:

StringAttribute.setVisibility(Settable.Visibility)

setVisibility

public void setVisibility(Settable.Visibility visibility)

The visibility cannot be changed. This method does nothing.

Specified by:

setVisibility in interface Settable

Overrides:

setVisibility in class StringAttribute

Parameters:

visibility - The new visibility value

See Also:

StringAttribute.getVisibility()

validate

public java.util.Collection validate()
                              throws IllegalActionException

Validate the expression. The expression is valid if it has a corresponding port.

Specified by:

validate in interface Settable

Overrides:

validate in class StringAttribute

Returns:

Null, indicating that no other instances of Settable are validated.

Throws:

IllegalActionException - If the change is not acceptable to the container.

equals

public boolean equals(java.lang.Object obj)

References are equal when they refer to the same port.

Overrides:

equals in class java.lang.Object