Package ptolemy.domains.tdl.kernel

Class TDLTaskPort

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.Port

ptolemy.kernel.ComponentPort

ptolemy.actor.IOPort

ptolemy.actor.TypedIOPort

ptolemy.domains.tdl.kernel.TDLTaskPort

All Implemented Interfaces:

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

public class TDLTaskPort
extends TypedIOPort

A TDL task output port has some TDL specific parameters. - initialValue: a TDL output port has an initial value.

Since:

Ptolemy II 8.0

Version:

$Id$

Author:

Patricia Derler

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.actor.TypedIOPort

TypedIOPort.RunTimeTypeCheckException

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

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
Parameter	initialValue	The initial value of the task.

Fields inherited from class ptolemy.actor.TypedIOPort

_resolvedType, TYPE

Fields inherited from class ptolemy.actor.IOPort

_constantLimit, _constantToken, _constantTokensSent, _hasPortEventListeners, _portEventListeners, CONFIGURATION, defaultValue, RECEIVERS, REMOTERECEIVERS

Fields inherited from class ptolemy.kernel.Port

_insideLinks, _relationsList

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	Description
TDLTaskPort()	Construct a TypedIOPort with no container and no name that is neither an input nor an output.
TDLTaskPort(ComponentEntity container, java.lang.String name)	Construct a TypedIOPort with a containing actor and a name that is neither an input nor an output.
TDLTaskPort(ComponentEntity container, java.lang.String name, boolean isInput, boolean isOutput)	Construct a TypedIOPort with a container and a name that is either an input, an output, or both, depending on the third and fourth arguments.
TDLTaskPort(Workspace workspace)	Construct a port in the specified workspace with an empty string as a name.

Method Summary

Modifier and Type	Method	Description
void	setInput(boolean isInput)	Sets the port of a task to an input port.
void	setOutput(boolean isOutput)	Sets the port of a task to an output port.

Methods inherited from class ptolemy.actor.TypedIOPort

_checkContainer, _checkLiberalLink, _checkLink, _checkType, _checkTypedIOPortContainer, _description, addTypeListener, attributeChanged, broadcast, broadcast, clone, convert, getAutomaticTypeConversion, getType, getTypeTerm, isTypeAcceptable, removeTypeListener, send, send, sendInside, setAutomaticTypeConversion, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.IOPort

_checkLiberalLink, _exportMoMLContents, _getInsideWidth, _getOutsideWidth, _getReceiversLinkedToGroup, _newInsideReceiver, _newInsideReceiver, _newReceiver, _newReceiver, _notifyPortEventListeners, _removeReceivers, _setConstant, _wrapReceiver, addIOPortEventListener, broadcastClear, checkWidthConstraints, createReceivers, deepConnectedInPortList, deepConnectedInPorts, deepConnectedOutPortList, deepConnectedOutPorts, deepGetReceivers, get, get, getChannelForReceiver, getCommunicationAspects, getCurrentTime, getDefaultWidth, getInside, getInsideReceivers, getIOPortEventListeners, getModelTime, getModelTime, getReceivers, getReceivers, getReceivers, getRelationIndex, getRemoteReceivers, getRemoteReceivers, getWidth, getWidthFromConstraints, getWidthInside, hasNewToken, hasNewTokenInside, hasRoom, hasRoomInside, hasToken, hasToken, hasTokenInside, hasWidthConstraints, insertLink, insideSinkPortList, insideSourcePortList, invalidateCommunicationAspects, isInput, isInsideConnected, isKnown, isKnown, isKnownInside, isMultiport, isOutput, isOutsideConnected, liberalLink, link, numberOfSinks, numberOfSources, removeIOPortEventListener, reset, sendClear, sendClearInside, setContainer, setDefaultWidth, setMultiport, setWidthEquals, setWidthEquals, sinkPortList, sourcePortList, transferInputs, transferOutputs, unlink, unlink, unlinkAll, unlinkAllInside, unlinkInside, unlinkInside

Methods inherited from class ptolemy.kernel.ComponentPort

_deepConnectedPortList, _deepConnectedPorts, _deepInsidePortList, _deepInsidePorts, _isInsideLinkable, deepConnectedPortList, deepConnectedPorts, deepInsidePortList, deepInsidePorts, insertInsideLink, insidePortList, insidePorts, insideRelationList, insideRelations, isDeeplyConnected, isInsideGroupLinked, isInsideLinked, isOpaque, numInsideLinks

Methods inherited from class ptolemy.kernel.Port

_getContainedObject, _propagateExistence, connectedPortList, connectedPorts, getContainer, isGroupLinked, isLinked, linkedRelationList, linkedRelations, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, numLinks, setName

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, 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

Field Detail

initialValue

public Parameter initialValue

The initial value of the task.

Constructor Detail

TDLTaskPort

public TDLTaskPort()
            throws IllegalActionException,
                   NameDuplicationException

Construct a TypedIOPort with no container and no name that is neither an input nor an output.

Throws:

NameDuplicationException

IllegalActionException

TDLTaskPort

public TDLTaskPort(Workspace workspace)
            throws IllegalActionException,
                   NameDuplicationException

Construct a port in the specified workspace with an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. The object is added to the workspace directory. Increment the version number of the workspace.

Parameters:

workspace - The workspace that will list the port.

Throws:

NameDuplicationException - Thrown if the initial value parameter cannot be created.

IllegalActionException - Thrown if the initial value parameter cannot be created.

TDLTaskPort

public TDLTaskPort(ComponentEntity container,
                   java.lang.String name)
            throws IllegalActionException,
                   NameDuplicationException

Construct a TypedIOPort with a containing actor and a name that is neither an input nor an output. The specified container must implement the TypedActor interface, or an exception will be thrown.

Parameters:

container - The container actor.

name - The name of the port.

Throws:

IllegalActionException - If the port is not of an acceptable class for the container, or if the container does not implement the TypedActor interface.

NameDuplicationException - If the name coincides with a port already in the container.

TDLTaskPort

public TDLTaskPort(ComponentEntity container,
                   java.lang.String name,
                   boolean isInput,
                   boolean isOutput)
            throws IllegalActionException,
                   NameDuplicationException

Construct a TypedIOPort with a container and a name that is either an input, an output, or both, depending on the third and fourth arguments. The specified container must implement the TypedActor interface or an exception will be thrown.

Parameters:

container - The container actor.

name - The name of the port.

isInput - True if this is to be an input port.

isOutput - True if this is to be an output port.

Throws:

IllegalActionException - If the port is not of an acceptable class for the container, or if the container does not implement the TypedActor interface.

NameDuplicationException - If the name coincides with a port already in the container.

Method Detail

setInput

public void setInput(boolean isInput)
              throws IllegalActionException

Sets the port of a task to an input port.

Overrides:

setInput in class IOPort

Parameters:

isInput - true if port is an input port.

Throws:

IllegalActionException - Thrown by parent class.

setOutput

public void setOutput(boolean isOutput)
               throws IllegalActionException

Sets the port of a task to an output port.

Overrides:

setOutput in class IOPort

Parameters:

isOutput - true if port is an output port.

Throws:

IllegalActionException - Thrown by parent class.