org.kepler.sms

Class KeplerIOPortSemanticLink

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

org.kepler.sms.KeplerIOPortSemanticLink

All Implemented Interfaces:

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

public class KeplerIOPortSemanticLink
extends Attribute

FIXME: Documentation ... A port generalization is a virtual port that encapsulates a set of underlying ports (both ptolemy ports and other virtual ports). A port generalization (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 port generalization may only be contained within an entity (e.g., an actor). A virtual port must have a name.

Author:

Shawn Bowers

Created:

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

Method Summary

Modifier and Type	Method and Description
void	addSemanticProperty(SemanticProperty property)
java.lang.Object	getDomain()
java.lang.Object	getRange()
java.util.Vector<SemanticProperty>	getSemanticProperties()
void	setContainer(NamedObj container) FIXME: This should be "external" to the port ...
void	setDomain(IOPort domain) Assigns the domain of this link.
void	setDomain(KeplerVirtualIOPort domain) Assigns the domain of this link.
void	setRange(IOPort range) Assigns the IOPort as the range of the link.
void	setRange(KeplerVirtualIOPort range) Assigns the Virtual IOPort as the range of the link.

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, 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, _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, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

KeplerIOPortSemanticLink

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

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

FIXME: This should be "external" to the port ... Set the container of the link to the given container. This method fails, in addition to the normal ptolemy constraints for setting containers, if the given container is not a org.kepler.sms.KeplerVirtualIOPort or ptolemy IOPort object.

Overrides:

setContainer in class Attribute

Parameters:

container - The container for this virtual port.

Throws:

IllegalActionException - If this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment.

NameDuplicationException - If the container already has an attribute with the name of this attribute.

See Also:

Attribute.getContainer()

getDomain

public java.lang.Object getDomain()

Returns:

The domain of the link, which is an IOPort or KeplerVirtualIOPort.

setDomain

public void setDomain(IOPort domain)
               throws IllegalActionException,
                      NameDuplicationException

Assigns the domain of this link. As a side effect, makes the domain the container for this object.

Throws:

IllegalActionException

NameDuplicationException

setDomain

public void setDomain(KeplerVirtualIOPort domain)
               throws IllegalActionException,
                      NameDuplicationException

Assigns the domain of this link. As a side effect, makes the domain the container for this object.

Throws:

IllegalActionException

NameDuplicationException

getRange

public java.lang.Object getRange()

Returns:

The range of the link, which is an IOPort or KeplerVirtualIOPort

setRange

public void setRange(IOPort range)
              throws IllegalActionException,
                     NameDuplicationException

Assigns the IOPort as the range of the link. Removes the current range if one exists.

Throws:

IllegalActionException

NameDuplicationException

setRange

public void setRange(KeplerVirtualIOPort range)
              throws IllegalActionException,
                     NameDuplicationException

Assigns the Virtual IOPort as the range of the link. Removes the current range if one exists.

Throws:

IllegalActionException

NameDuplicationException

getSemanticProperties

public java.util.Vector<SemanticProperty> getSemanticProperties()

addSemanticProperty

public void addSemanticProperty(SemanticProperty property)
                         throws IllegalActionException,
                                NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException