org.kepler.sms

Class KeplerCompositeIOPort

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

org.kepler.sms.KeplerVirtualIOPort

org.kepler.sms.KeplerCompositeIOPort

All Implemented Interfaces:

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

public class KeplerCompositeIOPort
extends KeplerVirtualIOPort

A compoiste port is a virtual port that encapsulates a set of underlying ports (both ptolemy ports and other virtual ports). A composite port (and virtual ports in general) can be annotated using semantic types. For example, given an actor with a 'lat' and 'lon' port, a port generalization 'pg' can be constructed that encapsulates both 'lat' and 'lon'; and a semantic type such as "Location" can be assigned to 'pg', stating that 'lat' and 'lon' values combined form a location value.

A compoiste port may only be contained within an entity (e.g., an actor). A virtual port must have a name.

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
KeplerCompositeIOPort(NamedObj container, java.lang.String name) Constructor

Method Summary

Modifier and Type	Method and Description
void	addEncapsulatedPort(IOPort port) Assigns the given ptolemy port reference to the current set of encapsulated ports.
void	addEncapsulatedPort(KeplerVirtualIOPort port) Assigns the given virtual port to the current set of encapsulated ports.
java.util.Vector	getEncapsulatedPortReferences()
Type	getType() Returns a record type of the encapsulated ports, where the labels are the port names.
boolean	isInput()
boolean	isOutput()
void	setName(java.lang.String name) Set the name of the attribute.
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

KeplerCompositeIOPort

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

Description copied from class: Attribute

Set the name of the attribute. If there is already an attribute of the container with the same name, then throw a NameDuplicationException.

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)

getEncapsulatedPortReferences

public java.util.Vector getEncapsulatedPortReferences()

Returns:

The list of encapsulated port references for this port generalization. Each returned reference can be called to obtain the actual port.

addEncapsulatedPort

public void addEncapsulatedPort(IOPort port)
                         throws IllegalActionException,
                                NameDuplicationException

Assigns the given ptolemy port reference to the current set of encapsulated ports. Creates a new reference for the port and adds to the generalization.

Parameters:

port - The ptolemy port to encapsulate.

Throws:

IllegalActionException

NameDuplicationException

addEncapsulatedPort

public void addEncapsulatedPort(KeplerVirtualIOPort port)
                         throws IllegalActionException,
                                NameDuplicationException

Assigns the given virtual port to the current set of encapsulated ports. This operation creates a reference to the given port.

Parameters:

vport - The virtual port to encapsulate.

Throws:

IllegalActionException

NameDuplicationException

isOutput

public boolean isOutput()

Specified by:

isOutput in class KeplerVirtualIOPort

Returns:

True if the port is considered an output.

isInput

public boolean isInput()

Specified by:

isInput in class KeplerVirtualIOPort

Returns:

True if the port is considered an input.

getType

public Type getType()

Returns a record type of the encapsulated ports, where the labels are the port names.

Specified by:

getType in class KeplerVirtualIOPort

Returns:

The data type of the virtual port. If no type exists, then null.

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.