|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectptolemy.kernel.util.NamedObj
ptolemy.kernel.Relation
ptolemy.kernel.ComponentRelation
ptolemy.actor.IORelation
This class mediates connections between ports that can send data to one another via message passing. One purpose of this relation is to ensure that IOPorts are only connected to IOPorts. A second purpose is to support the notion of a width to represent something like a bus. By default an IORelation is not a bus, which means that its width can only be zero or one. Calling setWidth() with an argument larger than one makes the relation a bus of fixed width. Calling setWidth() with an argument of zero makes the relation a bus with indeterminate width, in which case the width will be inferred (if possible) from the context. The actual width of an IORelation can never be less than one.
Instances of IORelation can only be linked to instances of IOPort. Derived classes may further constrain this to subclasses of IOPort. Such derived classes should override the protected method _checkPort() to throw an exception.
To link a IOPort to a IORelation, use the link() or liberalLink() method in the IOPort class. To remove a link, use the unlink() method.
The container for instances of this class can only be instances of CompositeActor. Derived classes may wish to further constrain the container to subclasses of ComponentEntity. To do this, they should override the _checkContainer() method.
| Green (davisj) |
| Green (eal) |
| Nested Class Summary |
| Nested classes inherited from class ptolemy.kernel.util.NamedObj |
NamedObj.ContainedObjectsIterator |
| Field Summary | |
static int |
CONFIGURATION
Indicate that the description(int) method should describe the width of the relation, and whether it has been fixed. |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
| Constructor Summary | |
IORelation()
Construct a relation in the default workspace with an empty string as its name. |
|
IORelation(CompositeEntity container,
java.lang.String name)
Construct a relation with the given name contained by the specified entity. |
|
IORelation(Workspace workspace)
Construct a relation in the specified workspace with an empty string as a name. |
|
| Method Summary | |
protected void |
_checkPort(Port port)
Throw an exception if the specified port cannot be linked to this relation (is not of class IOPort). |
protected java.lang.String |
_description(int detail,
int indent,
int bracket)
Return a description of the object. |
void |
attributeChanged(Attribute attribute)
React to a change in an attribute. |
java.lang.Object |
clone(Workspace workspace)
Clone the object into the specified workspace. |
Receiver[][] |
deepReceivers(IOPort except)
Return the receivers of all input ports linked to this relation, directly or indirectly, except those in the port given as an argument. |
int |
getWidth()
Return the width of the IORelation, which is always at least one. |
boolean |
isWidthFixed()
Return true if the relation has a definite width (i.e., setWidth() has not been called with a zero argument). |
java.util.List |
linkedDestinationPortList()
List the input ports that we are linked to from the outside, and the output ports that we are linked to from the inside. |
java.util.List |
linkedDestinationPortList(IOPort except)
Enumerate the input ports that we are linked to from the outside, and the output ports that we are linked to from the inside, except the port given as an argument and return a list of list of these ports. |
java.util.Enumeration |
linkedDestinationPorts()
Deprecated. Use linkedDestinationPortList() instead. |
java.util.Enumeration |
linkedDestinationPorts(IOPort except)
Deprecated. Use linkDestinationPortList(IOPort) instead. |
java.util.List |
linkedSourcePortList()
List the output ports that we are linked to from the outside and the input ports that we are linked to from the inside. |
java.util.List |
linkedSourcePortList(IOPort except)
List the output ports that we are linked to from the outside and the input ports that we are linked to from the inside. |
java.util.Enumeration |
linkedSourcePorts()
Deprecated. Use linkedSourcePortList() instead. |
java.util.Enumeration |
linkedSourcePorts(IOPort except)
Deprecated. Use linkedSourcePortList(IOPort) instead. |
void |
setContainer(CompositeEntity container)
Specify the container, adding the relation to the list of relations in the container. |
void |
setWidth(int width)
Set the width of the IORelation. |
| Methods inherited from class ptolemy.kernel.ComponentRelation |
_checkContainer, _propagateExistence, deepLinkedPortList, deepLinkedPorts, getContainer, setName, unlinkAll |
| Methods inherited from class ptolemy.kernel.Relation |
_getContainedObject, _getPortList, linkedPortList, linkedPortList, linkedPorts, linkedPorts, numLinks |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final int CONFIGURATION
| Constructor Detail |
public IORelation()
public IORelation(Workspace workspace)
workspace - The workspace that will list the relation.
public IORelation(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
container - The container.name - The name of the relation.
IllegalActionException - If the container is incompatible
with this relation.
NameDuplicationException - If the name coincides with
a relation already in the container.| Method Detail |
public void attributeChanged(Attribute attribute)
throws IllegalActionException
attributeChanged in class NamedObjattribute - The attribute that changed.
IllegalActionException - If the change is not acceptable
to this container.
public java.lang.Object clone(Workspace workspace)
throws java.lang.CloneNotSupportedException
clone in class ComponentRelationworkspace - The workspace for the cloned object.
java.lang.CloneNotSupportedException - If one or more of the attributes
cannot be cloned.public Receiver[][] deepReceivers(IOPort except)
The number of groups (rows) is less than or equal to the width of the relation, which is always at least one. If there are no receivers then return null.
For each channel, there may be any number of receivers in the group. The individual receivers are selected using the second index of the returned array of arrays. If there are no receivers in the group, then the channel is represented by null. I.e., if the returned array of arrays is x and the channel number is c, then x[c] is null. Otherwise, it is an array, where the size of the array is the number of receivers in the group.
NOTE: This method may have the effect of creating new receivers in the remote input ports and losing the previous receivers in those ports, together with any data they may contain. This occurs only if the topology has changed since the receivers were created, and that change resulting in one of those ports not having the right number of receivers.
This method read-synchronizes on the workspace.
except - The port to exclude.
IOPort.getRemoteReceivers()public int getWidth()
public boolean isWidthFixed()
public java.util.List linkedDestinationPortList()
Relation.linkedPorts()public java.util.List linkedDestinationPortList(IOPort except)
except - The port not included in the returned Enumeration.
Relation.linkedPorts(ptolemy.kernel.Port)public java.util.Enumeration linkedDestinationPorts()
Relation.linkedPorts()public java.util.Enumeration linkedDestinationPorts(IOPort except)
except - The port not included in the returned Enumeration.
Relation.linkedPorts(ptolemy.kernel.Port)public java.util.List linkedSourcePortList()
Relation.linkedPorts()public java.util.List linkedSourcePortList(IOPort except)
except - The port not included in the returned list.
Relation.linkedPorts(ptolemy.kernel.Port)public java.util.Enumeration linkedSourcePorts()
Relation.linkedPorts()public java.util.Enumeration linkedSourcePorts(IOPort except)
except - The port not included in the returned Enumeration.
Relation.linkedPorts(ptolemy.kernel.Port)
public void setContainer(CompositeEntity container)
throws IllegalActionException,
NameDuplicationException
The container must be an instance of CompositeActor or null, otherwise an exception is thrown. Derived classes may further constrain the class of the container to a subclass of CompositeActor.
This method invalidates the schedule and resolved types of the director of the container, if there is one.
This method is write-synchronized on the workspace.
setContainer in class ComponentRelationcontainer - The proposed container.
IllegalActionException - If the container is not a
CompositeActor or null, or this entity and the container are not in
the same workspace.
NameDuplicationException - If the name collides with a name
already on the relations list of the container.ComponentRelation.getContainer()
public void setWidth(int width)
throws IllegalActionException
width - The width of the relation.
IllegalActionException - If the argument is greater than
one and the relation is linked to a non-multiport, or it is zero and
the relation is linked on the inside to a port that is already
linked on the inside to a relation with unspecified width.Workspace.getWriteAccess()
protected void _checkPort(Port port)
throws IllegalActionException
_checkPort in class ComponentRelationport - The candidate port to link to.
IllegalActionException - If the port is not an IOPort.
protected java.lang.String _description(int detail,
int indent,
int bracket)
If the detail argument sets the bit defined by the constant CONFIGURATION, then append to the description is a field of the form "configuration {width integer ?fixed?}", where the word "fixed" is present if the relation has fixed width, and is absent if the relation is a bus with inferred width (isWidthFixed() returns false). This method is read-synchronized on the workspace.
_description in class Relationdetail - The level of detail.indent - The amount of indenting.bracket - The number of surrounding brackets (0, 1, or 2).
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||