ptolemy.domains.wireless.kernel
Class ChannelPort

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.Port
          extended byptolemy.kernel.ComponentPort
              extended byptolemy.actor.IOPort
                  extended byptolemy.actor.TypedIOPort
                      extended byptolemy.domains.wireless.kernel.WirelessIOPort
                          extended byptolemy.domains.wireless.kernel.ChannelPort
All Implemented Interfaces:
ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.data.type.HasTypeConstraints, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.data.type.Typeable

public class ChannelPort
extends WirelessIOPort

This port is used in a channel to mediate type constraints between senders and receivers on a wireless channel. The way it works is by pretending that it receives data from the sender and sends data to the receiver. It does not actually get involved in the transmission of data (that is handled by the transmit() method of the channel). This port is always both an input and an output. This port is not persistent and is always hidden in a user interface.

NOTE: Someday, perhaps this port will be augmented to mediate the communication and facilitate the construction of channel models as composite actors instead of atomic actors).

Since:
Ptolemy II 4.0
Version:
$Id: ChannelPort.java,v 1.14 2004/04/13 03:37:31 cxh Exp $
Author:
Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Yellow (cxh)
Proposed Rating:
Green (cxh)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.util.NamedObj
ptolemy.kernel.util.NamedObj.ContainedObjectsIterator
 
Field Summary
 
Fields inherited from class ptolemy.domains.wireless.kernel.WirelessIOPort
insideChannel, insideTransmitProperties, outsideChannel, outsideTransmitProperties
 
Fields inherited from class ptolemy.actor.TypedIOPort
TYPE
 
Fields inherited from class ptolemy.actor.IOPort
CONFIGURATION, RECEIVERS, REMOTERECEIVERS
 
Fields inherited from class ptolemy.kernel.Port
_insideLinks, _relationsList
 
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
ChannelPort(ptolemy.kernel.ComponentEntity container, java.lang.String name)
          Construct a port with the specified container and name that is both an input and an output.
 
Method Summary
 int numberOfSinks()
          Return the number of sink ports that can potentially receive data from the containing channel.
 int numberOfSources()
          Return the number of source ports that can potentially send data to the containing channel.
 void setContainer(ptolemy.kernel.Entity container)
          Override the base class to ensure that the proposed container implements the WirelessChannel interface.
 java.util.List sinkPortList()
          Return a list of the ports that can potentially accept data from the containing channel.
 java.util.List sourcePortList()
          Return a list of the ports that can potentially send data to the containing channel.
 
Methods inherited from class ptolemy.domains.wireless.kernel.WirelessIOPort
_insideIsWireless, _outsideIsWireless, attributeChanged, broadcast, broadcast, broadcastClear, createReceivers, getInsideChannel, getInsideReceivers, getOutsideChannel, getProperties, getPropertiesInside, getReceivers, getWidth, getWidthInside, hasRoom, hasRoomInside, insideSinkPortList, insideSourcePortList, send, send, sendClear, sendClearInside, sendInside
 
Methods inherited from class ptolemy.actor.TypedIOPort
_checkContainer, _checkLiberalLink, _checkLink, _checkType, _description, addTypeListener, clone, convert, getType, getTypeTerm, isTypeAcceptable, removeTypeListener, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, typeConstraintList
 
Methods inherited from class ptolemy.actor.IOPort
_checkLiberalLink, _exportMoMLContents, _getInsideWidth, _newInsideReceiver, _newReceiver, deepConnectedInPortList, deepConnectedInPorts, deepConnectedOutPortList, deepConnectedOutPorts, deepGetReceivers, get, get, getCurrentTime, getInside, getReceivers, getReceivers, getRemoteReceivers, getRemoteReceivers, hasToken, hasToken, hasTokenInside, insertLink, isInput, isKnown, isKnown, isKnownInside, isMultiport, isOutput, liberalLink, link, setInput, setMultiport, setOutput, 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.Port
_getContainedObject, _propagateExistence, connectedPortList, connectedPorts, getContainer, isLinked, linkedRelationList, linkedRelations, numLinks, setName
 
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
 

Constructor Detail

ChannelPort

public ChannelPort(ptolemy.kernel.ComponentEntity container,
                   java.lang.String name)
            throws ptolemy.kernel.util.IllegalActionException,
                   ptolemy.kernel.util.NameDuplicationException
Construct a port with the specified container and name that is both an input and an output.

Parameters:
container - The container actor.
name - The name of the port.
Throws:
ptolemy.kernel.util.IllegalActionException - If the port is not of an acceptable class for the container, or if the container does not implement the Actor interface.
ptolemy.kernel.util.NameDuplicationException - If the name coincides with a port already in the container.
Method Detail

numberOfSinks

public int numberOfSinks()
Return the number of sink ports that can potentially receive data from the containing channel.

Overrides:
numberOfSinks in class WirelessIOPort
Returns:
The number of ports that can receive data from this one.

numberOfSources

public int numberOfSources()
Return the number of source ports that can potentially send data to the containing channel.

Overrides:
numberOfSources in class WirelessIOPort
Returns:
The number of ports that can send data to this one.

setContainer

public void setContainer(ptolemy.kernel.Entity container)
                  throws ptolemy.kernel.util.IllegalActionException,
                         ptolemy.kernel.util.NameDuplicationException
Override the base class to ensure that the proposed container implements the WirelessChannel interface.

Parameters:
container - The proposed container.
Throws:
ptolemy.kernel.util.IllegalActionException - If the proposed container is not a ComponentEntity, doesn't implement WirelessChannel, or has no name, or the port and container are not in the same workspace.
ptolemy.kernel.util.NameDuplicationException - If the container already has a port with the name of this port.

sinkPortList

public java.util.List sinkPortList()
Return a list of the ports that can potentially accept data from the containing channel. This includes all input ports that use that channel on the outside and all output ports that use the channel on the inside.

Overrides:
sinkPortList in class WirelessIOPort
Returns:
A list of WirelessIOPort objects.

sourcePortList

public java.util.List sourcePortList()
Return a list of the ports that can potentially send data to the containing channel. This includes all output ports that use that channel on the outside and all input ports that use it on the inside.

Overrides:
sourcePortList in class WirelessIOPort
Returns:
A list of IOPort objects.