ptolemy.domains.fsm.modal
Class TransitionRefinementPort
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.Port
ptolemy.kernel.ComponentPort
ptolemy.actor.IOPort
ptolemy.actor.TypedIOPort
ptolemy.domains.fsm.modal.RefinementPort
ptolemy.domains.fsm.modal.TransitionRefinementPort
- All Implemented Interfaces:
- Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, HasTypeConstraints, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, Typeable
- public class TransitionRefinementPort
- extends RefinementPort
A port for transition refinements in modal models. This port
mirrors certain changes to it in the ports of the container of the container.
That container in turn mirrors those changes in other refinements and/or
controllers.
For output ports, this class creates a sibling "input" port. The sibling
port is normally treated like any other port but mirrors changes via it's
output sibling. This is so that TransitionRefinement instances can get the
outputs from the State refinements without having the port be an input/output.
This sibling port is labeled as "port_in" where port is the name of the
corresponding output port.
- Since:
- Ptolemy II 2.1
- Version:
- $Id: TransitionRefinementPort.java,v 1.10 2004/05/02 00:22:48 eal Exp $
- Author:
- David Hermann, Research In Motion Limited
- See Also:
ModalPort,
TransitionRefinement,
Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
protected boolean |
_hasSibling
Flag indicating if this port has a sibling,
should be set for all output ports and their
associated input port siblings |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Method Summary |
void |
link(Relation relation)
Override the base class to avoid linking a sibling input port to
the same relation as the sibling output port multiple times. |
void |
setContainer(Entity container)
Override the base class so that if the port is being removed
from the current container, then it is also removed from the
controller and from each of the refinements. |
void |
setInput(boolean isInput)
If the argument is true, make the port an input port.
|
void |
setMultiport(boolean isMultiport)
If the argument is true, make the port a multiport.
|
void |
setName(java.lang.String name)
Set the name of the port, and mirror the change in all the
mirror ports.
|
void |
setOutput(boolean isOutput)
If the argument is true, make the port an output port.
|
| Methods inherited from class ptolemy.actor.TypedIOPort |
_checkContainer, _checkLiberalLink, _checkLink, _checkType, _description, addTypeListener, attributeChanged, broadcast, broadcast, clone, convert, getType, getTypeTerm, removeTypeListener, send, send, sendInside, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, typeConstraintList |
| Methods inherited from class ptolemy.actor.IOPort |
_checkLiberalLink, _exportMoMLContents, _getInsideWidth, _newInsideReceiver, _newReceiver, broadcastClear, createReceivers, deepConnectedInPortList, deepConnectedInPorts, deepConnectedOutPortList, deepConnectedOutPorts, deepGetReceivers, get, get, getCurrentTime, getInside, getInsideReceivers, getReceivers, getReceivers, getReceivers, getRemoteReceivers, getRemoteReceivers, getWidth, getWidthInside, hasRoom, hasRoomInside, hasToken, hasToken, hasTokenInside, insertLink, insideSinkPortList, insideSourcePortList, isInput, isKnown, isKnown, isKnownInside, isMultiport, isOutput, liberalLink, numberOfSinks, numberOfSources, sendClear, sendClearInside, 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, isInsideLinked, isOpaque, numInsideLinks |
| Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, uniqueName, validateSettables, workspace |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
_hasSibling
protected boolean _hasSibling
- Flag indicating if this port has a sibling,
should be set for all output ports and their
associated input port siblings
TransitionRefinementPort
public TransitionRefinementPort(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.
link
public void link(Relation relation)
throws IllegalActionException
- Override the base class to avoid linking a sibling input port to
the same relation as the sibling output port multiple times.
- Overrides:
link in class IOPort
- Parameters:
relation - The relation to link to.
- Throws:
IllegalActionException - If the link crosses levels of
the hierarchy, or the port has no container, or the relation
is not an instance of IORelation.
setContainer
public void setContainer(Entity container)
throws IllegalActionException,
NameDuplicationException
- Override the base class so that if the port is being removed
from the current container, then it is also removed from the
controller and from each of the refinements.
- Overrides:
setContainer in class RefinementPort
- Parameters:
container - The proposed container.
- Throws:
IllegalActionException - If the proposed container is not a
ComponentEntity, doesn't implement Actor, or has no name,
or the port and container are not in the same workspace. Or
it's not null
NameDuplicationException - If the container already has
a port with the name of this port.
setInput
public void setInput(boolean isInput)
throws IllegalActionException
- If the argument is true, make the port an input port.
If the argument is false, make the port not an input port.
This method overrides the base class to make the same
change on the mirror ports in the controller and state refinments.
This method invalidates the schedule and resolved types of the
director of the container, if there is one.
It is write-synchronized on the workspace, and increments
the version of the workspace.
- Overrides:
setInput in class RefinementPort
- Parameters:
isInput - True to make the port an input.
- Throws:
IllegalActionException - If changing the port status is
not permitted.
setMultiport
public void setMultiport(boolean isMultiport)
throws IllegalActionException
- If the argument is true, make the port a multiport.
If the argument is false, make the port not a multiport.
This method overrides the base class to make the same
change on the mirror ports in the controller and state refinments.
This method invalidates the schedule and resolved types of the
director of the container, if there is one.
It is write-synchronized on the workspace, and increments
the version of the workspace.
- Overrides:
setMultiport in class RefinementPort
- Parameters:
isMultiport - True to make the port a multiport.
- Throws:
IllegalActionException - If changing the port status is
not permitted.
setName
public void setName(java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Set the name of the port, and mirror the change in all the
mirror ports.
This method is write-synchronized on the workspace, and increments
the version of the workspace.
- Specified by:
setName in interface Nameable- Overrides:
setName in class RefinementPort
- Throws:
IllegalActionException - If the name has a period.
NameDuplicationException - If there is already a port
with the same name in the container.
setOutput
public void setOutput(boolean isOutput)
throws IllegalActionException
- If the argument is true, make the port an output port.
If the argument is false, make the port not an output port.
In addition, if the container is an instance of Refinement,
and the argument is true, find the corresponding port of the
controller and make it an input and not an output. This makes
it possible for the controller to see the outputs of the refinements.
This method overrides the base class to make the same
change on the mirror ports in the controller and state refinments.
This method invalidates the schedule and resolved types of the
director of the container, if there is one.
It is write-synchronized on the workspace, and increments
the version of the workspace.
- Overrides:
setOutput in class RefinementPort
- Parameters:
isOutput - True to make the port an output.
- Throws:
IllegalActionException - If changing the port status is
not permitted.