org.kepler.sms

Class KeplerVirtualIOPortReference

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

org.kepler.sms.KeplerIOPortReference

org.kepler.sms.KeplerVirtualIOPortReference

All Implemented Interfaces:

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

public class KeplerVirtualIOPortReference
extends KeplerIOPortReference

A KeplerVirtualPortReference refers to a kepler virtual port within its containing entity. The virutal port is referenced by its 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
KeplerVirtualIOPortReference() Constructor
KeplerVirtualIOPortReference(NamedObj container, java.lang.String name) Constructor
KeplerVirtualIOPortReference(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(KeplerVirtualIOPort port) Sets the reference to the given virtual port.
void	setVisibility(Settable.Visibility visibility) The visibility cannot be changed.
java.util.Collection	validate() Validate the expression.

Methods inherited from class org.kepler.sms.KeplerIOPortReference

setPort

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

KeplerVirtualIOPortReference

public KeplerVirtualIOPortReference()

Constructor

KeplerVirtualIOPortReference

public KeplerVirtualIOPortReference(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

KeplerVirtualIOPortReference

public KeplerVirtualIOPortReference(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 KeplerIOPortReference

Returns:

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

See Also:

AbstractSettableAttribute.setExpression(String), Instantiable

getPort

public java.lang.Object getPort()

Description copied from class: KeplerIOPortReference

Return the corresponding IOPort for the reference.

Overrides:

getPort in class KeplerIOPortReference

Returns:

The virtual port being referenced.

setPort

public void setPort(KeplerVirtualIOPort port)
             throws IllegalActionException

Sets the reference to the given virtual port.

Parameters:

vport - The virtual port that this reference will refer to. The virtual port must be within the same container.

Throws:

IllegalActionException

getVisibility

public Settable.Visibility getVisibility()

Set visibility to NOT_EDITABLE

Specified by:

getVisibility in interface Settable

Overrides:

getVisibility in class KeplerIOPortReference

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 KeplerIOPortReference

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 virtual port.

Specified by:

validate in interface Settable

Overrides:

validate in class KeplerIOPortReference

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 KeplerIOPortReference