org.kepler.sms

Class KeplerRefinementIOPort

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

org.kepler.sms.KeplerVirtualIOPort

org.kepler.sms.KeplerRefinementIOPort

All Implemented Interfaces:

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

public class KeplerRefinementIOPort
extends KeplerVirtualIOPort

A refinement port is a virtual port that denotes a particular nested structure within a port's value. A refinement port (and virtual ports in general) can be annotated using semantic types. For example, given an actor with a port p1 having type {lat=int, lon=int}, i.e., the port type is a record having a lat and lon component, a port refinement 'p1/lat' can be constructed that denotes the lat values (integers); and a semantic type such as "Latitude" can be assigned to 'p1/lat'.

A port refinement may only be contained within an entity (e.g., an actor). All port refinements are required to have a well-formed port name, representing the actual "pointer" into the port's data structure. The pointer 'elem' is used to denote traversal into an array (list) or matrix, and the component name (e.g., 'lat') is used to denote traversal into a record.

Author:

Shawn Bowers

Created:

June 16, 2005

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, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Constructor and Description
KeplerRefinementIOPort(NamedObj container, java.lang.String name) Constructor

Method Summary

Modifier and Type	Method and Description
TypedIOPort	_getPort(java.lang.String pointer)
java.lang.String	getPointer()
TypedIOPort	getRefinedPort()
java.lang.String	getTargetName()
Type	getType() ...
boolean	isInput()
boolean	isOutput()
void	setName(java.lang.String name) Calls setRefinedPortPointer to set the pointer.
void	setPointer(java.lang.String pointer) Assign the given pointer (name) to the port.
java.lang.String	toString() Return the class name and the full name of the object, with syntax "className {fullName}".

Methods inherited from class org.kepler.sms.KeplerVirtualIOPort

setContainer

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, 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, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, 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, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

KeplerRefinementIOPort

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

Method Detail

setName

public void setName(java.lang.String name)
             throws IllegalActionException,
                    NameDuplicationException

Calls setRefinedPortPointer to set the pointer.

Specified by:

setName in interface Nameable

Overrides:

setName in class Attribute

Parameters:

name - The new name.

Throws:

IllegalActionException - If the name contains a period.

NameDuplicationException - If there is already an attribute with the same name in the container.

See Also:

NamedObj.getName(), NamedObj.getName(NamedObj)

setPointer

public void setPointer(java.lang.String pointer)
                throws IllegalActionException,
                       NameDuplicationException

Assign the given pointer (name) to the port. The pointer cannot be null and must be well-formed. A well-formed pointer takes the form: p/s_1/s_2/ ... /s_n for n > 0, where p is a port name, and s_1 to s_n are strings.

Throws:

IllegalActionException

NameDuplicationException

getRefinedPort

public TypedIOPort getRefinedPort()

Returns:

Retrieve the ptolemy port refined by this virtual port. Note that the port must reside within the same actor as this refinement.

_getPort

public TypedIOPort _getPort(java.lang.String pointer)

getPointer

public java.lang.String getPointer()

Returns:

Returns the pointer (i.e., name) of the port.

isOutput

public boolean isOutput()

Specified by:

isOutput in class KeplerVirtualIOPort

Returns:

True if the refined port is an output port.

isInput

public boolean isInput()

Specified by:

isInput in class KeplerVirtualIOPort

Returns:

True if the refined port is an input port.

getType

public Type getType()

...

Specified by:

getType in class KeplerVirtualIOPort

Returns:

The type associated with the pointer.

getTargetName

public java.lang.String getTargetName()

toString

public java.lang.String toString()

Description copied from class: NamedObj

Return the class name and the full name of the object, with syntax "className {fullName}".

Overrides:

toString in class NamedObj

Returns:

The class name and the full name.