Package ptolemy.domains.tdl.kernel

Class TDLRefinementPort

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.Port

ptolemy.kernel.ComponentPort

ptolemy.actor.IOPort

ptolemy.actor.TypedIOPort

ptolemy.domains.modal.modal.ModalBasePort

ptolemy.domains.modal.modal.RefinementPort

ptolemy.domains.tdl.kernel.TDLRefinementPort

All Implemented Interfaces:

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

public class TDLRefinementPort
extends RefinementPort

The TDL refinement port represents an actuator and has some TDL specific parameters: - frequency: update frequency - initialValue: at time 0, this initial value is used - fast: if the actuator is connected to a fast task, this parameter is true - slots: string that supports TDL slot selection.

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	fast	Describes a fast actuator.
Parameter	frequency	frequency for the port update.
Parameter	initialValue	Initial value of the port.
Parameter	slots	Slot selection string.

Fields inherited from class ptolemy.domains.modal.modal.RefinementPort

_automaticallyInput, _mirrorDisable

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
TDLRefinementPort(ComponentEntity container, java.lang.String name)	Construct a port with a containing actor and a name that is neither an input nor an output.
TDLRefinementPort(Workspace workspace)	Construct a port in the given workspace.

Method Summary

Modifier and Type	Method	Description
void	setInput(boolean isInput)	Make port to an input port, for TDL this means that it is a sensor.
void	setOutput(boolean isOutput)	Make port to an output port, for TDL this means that it is an actuator.

Methods inherited from class ptolemy.domains.modal.modal.RefinementPort

_checkContainer, attributeChanged, isTypeAcceptable, link, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setMirrorDisable, setMultiport, setName, typeConstraints

Methods inherited from class ptolemy.domains.modal.modal.ModalBasePort

_moveDown, _moveToFirst, _moveToIndex, _moveToLast, _moveUp, _removePort, _setInput, _setMultiport, _setName, _setOutput

Methods inherited from class ptolemy.actor.TypedIOPort

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

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, numberOfSinks, numberOfSources, removeIOPortEventListener, reset, sendClear, sendClearInside, setDefaultWidth, 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, numLinks

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

frequency

public Parameter frequency

frequency for the port update.

initialValue

public Parameter initialValue

Initial value of the port.

fast

public Parameter fast

Describes a fast actuator.

slots

public Parameter slots

Slot selection string.

Constructor Detail

TDLRefinementPort

public TDLRefinementPort(Workspace workspace)
                  throws IllegalActionException,
                         NameDuplicationException

Construct a port in the given workspace.

Parameters:

workspace - The workspace.

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

TDLRefinementPort

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

Construct a port 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.

Method Detail

setOutput

public void setOutput(boolean isOutput)
               throws IllegalActionException

Make port to an output port, for TDL this means that it is an actuator.

Overrides:

setOutput in class RefinementPort

Parameters:

isOutput - True if port is an output port.

Throws:

IllegalActionException - Thrown by parent class.

setInput

public void setInput(boolean isInput)
              throws IllegalActionException

Make port to an input port, for TDL this means that it is a sensor.

Overrides:

setInput in class RefinementPort

Parameters:

isInput - True if port is an input port.

Throws:

IllegalActionException - Thrown by parent class.