ptolemy.domains.wireless.kernel
Class WirelessIOPort

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.Port
          ptolemy.kernel.ComponentPort
              ptolemy.actor.IOPort
                  ptolemy.actor.TypedIOPort
                      ptolemy.domains.wireless.kernel.WirelessIOPort

All Implemented Interfaces:

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

Direct Known Subclasses:

ChannelPort

public class WirelessIOPort
extends TypedIOPort

This port communicates via channels without wired connections. Channels are instances of WirelessChannel. The port references channels by name, where the name is specified by the outsideChannel or insideChannel parameter.

This port can be used on the boundary of wireless domain models. A port is outside wireless if an outside channel name is given and a wireless channel with the given name is contained by the container of the port's container (transparent hierarchy is not supported). Specially, it will use the specified wireless channel to communicate on the outside. A port is inside wireless if an inside channel name is given and a wireless channel with the given name is contained by the container of this port. It will use the specified wireless channel to communicate on the inside. If no outside channel or inside channel name is given or the named channel does not exist, then the behavior of the port reverts to that of the base class. Specifically, it will only communicate if it is wired.

It is valid for a model using the wireless director to have both wireless communication and wired communication, i.e. it may contain actors with ports using wireless communication (by specifying a wireless channel) and actors with ports using wired communication. If a port is outside/inside wireless(a wireless channel is specified), it will ignore all the communication through the wired connections to it if there is any on the outside/inside of it.

The width of this port on either side that is using wireless communication is fixed at one. Otherwise, it depends on the number of links to the port.

When this port is used for wireless communications, nothing is connected to it. Consequently, methods that access the topology such as connectedPortList() and deepConnectedInPortList() return an empty list. There are no deeply connected ports. However, sinkPortList() returns the port of the specified wireless channel. A consequence of this is that type constraints are automatically set up between ports that send on the channel and the channel port.

Since:

Ptolemy II 4.0

Version:

$Id: WirelessIOPort.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee and Xiaojun Liu

See Also:

Serialized Form

Accepted Rating:

Yellow (cxh)

Proposed Rating:

Green (cxh)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

private static Receiver[][]	_EMPTY_RECEIVERS
private WirelessChannel	_insideChannel
private long	_insideChannelVersion
private Receiver[][]	_insideReceivers
private WirelessChannel	_outsideChannel
private long	_outsideChannelVersion
private Receiver[][]	_receivers
StringParameter	insideChannel The name of the inside channel.
Parameter	insideTransmitProperties The transmit properties of this port for inside transmissions.
StringParameter	outsideChannel The name of the outside channel.
Parameter	outsideTransmitProperties The transmit properties of this port for outside transmissions.

Fields inherited from class ptolemy.actor.TypedIOPort

TYPE

Fields inherited from class ptolemy.actor.IOPort

_hasPortEventListeners, _portEventListeners, 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, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

WirelessIOPort(ComponentEntity container, java.lang.String name)
Construct a port with the specified container and name that is neither an input nor an output.

WirelessIOPort(ComponentEntity container, java.lang.String name, boolean isInput, boolean isOutput)
Construct a port with a container and a name that is either an input, an output, or both, depending on the third and fourth arguments.

WirelessIOPort(Workspace workspace)
Construct a port in the specified workspace with an empty string as a name.

Method Summary

protected boolean	_insideIsWireless() Return true if the port is inside wireless.
protected boolean	_outsideIsWireless() Return true if the port is outside wireless.
void	attributeChanged(Attribute attribute) If the attribute is one of the properties attributes, make sure its value is a record token.
void	broadcast(Token token) Override the base class to delegate to the channel if there is one.
void	broadcast(Token[] tokenArray, int vectorLength) Override the base class to delegate to the channel if there is one.
void	broadcastClear() Override the base class to delegate to the channel if there is one.
java.lang.Object	clone(Workspace workspace) Clone the object into the specified workspace.
void	createReceivers() Override the base class to create receivers for WirelessIOPort.
WirelessChannel	getInsideChannel() Get the channel specified by the insideChannel parameter.
Receiver[][]	getInsideReceivers() Override the base class to return the inside receiver for wireless communication if wireless communication is being used.
WirelessChannel	getOutsideChannel() Get the channel specified by the outsideChannel parameter.
Token	getProperties(int channelIndex) Get the properties token associated with the data token most recently retrieved using get().
Token	getPropertiesInside(int channelIndex) Get the properties token associated with the data token most recently retrieved using getInside().
Receiver[][]	getReceivers() Override the base class to return the outside receiver for wireless communication if wireless communication is being used.
int	getWidth() Get the width of the port.
int	getWidthInside() Return the inside width of this port.
boolean	hasRoom(int channelIndex) Override the base class to always return true if there is a wireless channel, and otherwise, defer to the base class.
boolean	hasRoomInside(int channelIndex) Override the base class to always return true if there is a wireless channel, and otherwise, defer to the base class.
java.util.List	insideSinkPortList() Return a list of the ports that can potentially accept data from this port when it sends on the inside.
java.util.List	insideSourcePortList() Return a list of the ports that can potentially send data to this port from the inside.
int	numberOfSinks() Return 1 if the port is outside wireless, which represents the channel port of the outside wireless channel.
int	numberOfSources() Return 1 if the port is outside wireless,, which represents the channel port of the outside wireless channel.
void	send(int channelIndex, Token token) Override the base class to delegate to the wireless channel if the port is outside wireless.
void	send(int channelIndex, Token[] tokenArray, int vectorLength) Override the base class to delegate to the wireless channel if the port is outside wireless.
void	sendClear(int channelIndex) Override the base class to delegate to the wireless channel if the port is outside wireless.
void	sendClearInside(int channelIndex) Override the base class to delegate to the wireless channel if the port is inside wireless.
void	sendInside(int channelIndex, Token token) Override the base class to delegate to the wireless channel if the port is inside wireless.
java.util.List	sinkPortList() Return a list of the ports that can potentially accept data from this port when it sends on the outside.
java.util.List	sourcePortList() Return a list of the ports that can potentially send data to this port from the outside.

Methods inherited from class ptolemy.actor.TypedIOPort

_checkContainer, _checkLiberalLink, _checkLink, _checkType, _description, addTypeListener, convert, getType, getTypeTerm, isTypeAcceptable, removeTypeListener, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.IOPort

_checkLiberalLink, _exportMoMLContents, _getInsideWidth, _getOutsideWidth, _getReceiversLinkedToGroup, _newInsideReceiver, _newReceiver, _notifyPortEventListeners, _removeReceivers, addIOPortEventListener, checkWidthConstraints, deepConnectedInPortList, deepConnectedInPorts, deepConnectedOutPortList, deepConnectedOutPorts, deepGetReceivers, get, get, getChannelForReceiver, getCurrentTime, getDefaultWidth, getInside, getModelTime, getReceivers, getReceivers, getRelationIndex, getRemoteReceivers, getRemoteReceivers, getWidthFromConstraints, hasToken, hasToken, hasTokenInside, hasWidthConstraints, insertLink, isInput, isInsideConnected, isKnown, isKnown, isKnownInside, isMultiport, isOutput, isOutsideConnected, liberalLink, link, removeIOPortEventListener, setContainer, setDefaultWidth, setInput, setMultiport, setOutput, setWidthEquals, setWidthEquals, 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, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, 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, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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

insideChannel

public StringParameter insideChannel

The name of the inside channel. This is a string that defaults to the empty string, indicating that communication is not wireless.

insideTransmitProperties

public Parameter insideTransmitProperties

The transmit properties of this port for inside transmissions. This field may be used by the channel to determine transmission range or other properties of the transmission. By default, this has no value, which indicates to channels to use their default properties, whatever those might be. When its value is set, it is required to be a record type.

outsideChannel

public StringParameter outsideChannel

The name of the outside channel. This is a string that defaults to the empty string, indicating that communication is not wireless.

outsideTransmitProperties

public Parameter outsideTransmitProperties

The transmit properties of this port for outside transmissions. This field may be used by the channel to determine transmission range or other properties of the transmission. By default, this has no value, which indicates to channels to use their default properties, whatever those might be. When its value is set, it is required to be a record type.

_EMPTY_RECEIVERS

private static Receiver[][] _EMPTY_RECEIVERS

_receivers

private Receiver[][] _receivers

_insideReceivers

private Receiver[][] _insideReceivers

_insideChannel

private WirelessChannel _insideChannel

_insideChannelVersion

private long _insideChannelVersion

_outsideChannel

private WirelessChannel _outsideChannel

_outsideChannelVersion

private long _outsideChannelVersion

Constructor Detail

WirelessIOPort

public WirelessIOPort(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:

IllegalActionException - If creating the parameters of this port throws it.

NameDuplicationException - If creating the parameters of this port throws it.

WirelessIOPort

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

Construct a port with the specified container and name that is neither an input nor an output. The specified container must implement the Actor 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 Actor interface.

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

WirelessIOPort

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

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

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

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

If the attribute is one of the properties attributes, make sure its value is a record token.

Overrides:

attributeChanged in class TypedIOPort

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container.

broadcast

public void broadcast(Token token)
               throws IllegalActionException

Override the base class to delegate to the channel if there is one. If there is no outside channel, then defer to the base class.

Overrides:

broadcast in class TypedIOPort

Parameters:

token - The token to send.

Throws:

IllegalActionException - If the port is not an output, or if the outsideChannel parameter cannot be evaluated or if the transmit() method throws an IllegalActionException.

broadcast

public void broadcast(Token[] tokenArray,
                      int vectorLength)
               throws IllegalActionException,
                      NoRoomException

Override the base class to delegate to the channel if there is one. If there is no outside channel, then defer to the base class.

Overrides:

broadcast in class TypedIOPort

Parameters:

tokenArray - The token array to send

vectorLength - The number of elements of the token array to send.

Throws:

NoRoomException - If there is no room in the receiver.

IllegalActionException - If the tokens to be sent cannot be converted to the type of this port

broadcastClear

public void broadcastClear()
                    throws IllegalActionException

Override the base class to delegate to the channel if there is one. If there is no outside channel, then clear as in the base class.

Overrides:

broadcastClear in class IOPort

Throws:

IllegalActionException - If a receiver does not support clear().

See Also:

IOPort.sendClear(int )

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the object into the specified workspace. The new object is not added to the directory of that workspace (you must do this yourself if you want it there).

Overrides:

clone in class TypedIOPort

Parameters:

workspace - The workspace for the cloned object.

Returns:

The new Attribute.

Throws:

java.lang.CloneNotSupportedException - Not thrown in this base class

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

createReceivers

public void createReceivers()
                     throws IllegalActionException

Override the base class to create receivers for WirelessIOPort. If there is an outside channel, create a receiver for outside communication. If there is an inside channel, create a receiver for inside communication.

Overrides:

createReceivers in class IOPort

Throws:

IllegalActionException - If this port is not an opaque input port or if there is no director.

getInsideChannel

public WirelessChannel getInsideChannel()
                                 throws IllegalActionException

Get the channel specified by the insideChannel parameter. The channel is contained by the container of this port. Transparent hierarchy is ignored in getting the inside channel.

Returns:

A wireless channel, or null if no channel is specified or if the specified channel does not exist.

Throws:

IllegalActionException - If the insideChannel parameter value cannot be evaluated.

getInsideReceivers

public Receiver[][] getInsideReceivers()

Override the base class to return the inside receiver for wireless communication if wireless communication is being used. Otherwise, defer to the base class.

Overrides:

getInsideReceivers in class IOPort

Returns:

The local inside receivers, or an empty array if there are none.

See Also:

IOPort.getInside(int)

getOutsideChannel

public WirelessChannel getOutsideChannel()
                                  throws IllegalActionException

Get the channel specified by the outsideChannel parameter. The channel is contained by the container of the container of this port. Transparent hierarchy is ignored in getting the outside channel.

Returns:

A wireless channel, or null if no channel is specified or if the specified channel does not exist.

Throws:

IllegalActionException - If the outsideChannel parameter value cannot be evaluated.

getProperties

public Token getProperties(int channelIndex)

Get the properties token associated with the data token most recently retrieved using get().

Parameters:

channelIndex - The channel index.

Returns:

The properties token of the most recently received data token, or null if there hasn't been one.

See Also:

IOPort.get(int), IOPort.get(int, int)

getPropertiesInside

public Token getPropertiesInside(int channelIndex)

Get the properties token associated with the data token most recently retrieved using getInside().

Parameters:

channelIndex - The channel index.

Returns:

The properties token of the most recently received data token, or null if there hasn't been one.

See Also:

IOPort.getInside(int)

getReceivers

public Receiver[][] getReceivers()

Override the base class to return the outside receiver for wireless communication if wireless communication is being used. Otherwise, defer to the base class.

Overrides:

getReceivers in class IOPort

Returns:

The local receivers, or an empty array if there are none.

getWidth

public int getWidth()
             throws IllegalActionException

Get the width of the port. If the outside is wireless, then the width is always 1. Otherwise, it depends on the number of links to the port.

Overrides:

getWidth in class IOPort

Returns:

The width of the port.

Throws:

IllegalActionException

See Also:

IOPort.numberOfSinks(), IOPort.numberOfSources()

getWidthInside

public int getWidthInside()
                   throws IllegalActionException

Return the inside width of this port. If the inside is wireless, then the width is always 1. Otherwise, the width is determined by the number of links to the port.

Overrides:

getWidthInside in class IOPort

Returns:

The inside width of this port.

Throws:

IllegalActionException

hasRoom

public boolean hasRoom(int channelIndex)
                throws IllegalActionException

Override the base class to always return true if there is a wireless channel, and otherwise, defer to the base class. For wireless channels, if a particular receiver does not have room, the channel treats it as if it were not in range.

Overrides:

hasRoom in class IOPort

Parameters:

channelIndex - The channel index.

Returns:

True if there is room for a token in the channel.

Throws:

IllegalActionException - If the receivers do not support this query, if this is not an output port, or if the channel index is out of range.

hasRoomInside

public boolean hasRoomInside(int channelIndex)
                      throws IllegalActionException

Override the base class to always return true if there is a wireless channel, and otherwise, defer to the base class. For wireless channels, if a particular receiver does not have room, the channel treats it as if it were not in range.

Overrides:

hasRoomInside in class IOPort

Parameters:

channelIndex - The channel index.

Returns:

True if there is room for a token in the channel.

Throws:

IllegalActionException - If the receivers do not support this query, if this is not an output port, or if the channel index is out of range.

insideSinkPortList

public java.util.List insideSinkPortList()

Return a list of the ports that can potentially accept data from this port when it sends on the inside. If the port is inside wireless, then this includes only the wireless channel port. Otherwise, this includes opaque input ports that are connected on the outside to this port and opaque output ports that are connected on the inside to this one.

Overrides:

insideSinkPortList in class IOPort

Returns:

A list of IOPort objects.

See Also:

IOPort.deepGetReceivers()

insideSourcePortList

public java.util.List insideSourcePortList()

Return a list of the ports that can potentially send data to this port from the inside. If the port is inside wireless, then this includes only the wireless channel port. Otherwise, this includes opaque output ports that are connected on the outside to this port and opaque input ports that are connected on the inside to this one.

Overrides:

insideSourcePortList in class IOPort

Returns:

A list of IOPort objects.

numberOfSinks

public int numberOfSinks()

Return 1 if the port is outside wireless, which represents the channel port of the outside wireless channel. If not, defer to the base class.

Overrides:

numberOfSinks in class IOPort

Returns:

The number of ports that can receive data from this one.

See Also:

IOPort.sinkPortList(), IOPort.numberOfSources(), IOPort.getWidth()

numberOfSources

public int numberOfSources()

Return 1 if the port is outside wireless,, which represents the channel port of the outside wireless channel. If not, defer to the base class.

Overrides:

numberOfSources in class IOPort

Returns:

The number of ports that can receive data from this one.

See Also:

IOPort.sourcePortList(), IOPort.numberOfSinks(), IOPort.getWidth()

send

public void send(int channelIndex,
                 Token token)
          throws IllegalActionException,
                 NoRoomException

Override the base class to delegate to the wireless channel if the port is outside wireless. If there is no outside channel, then defer to the base class.

Overrides:

send in class TypedIOPort

Parameters:

channelIndex - The index of the channel, from 0 to width-1. If there is an outside channel, then this argument is ignored.

token - The token to send.

Throws:

IllegalActionException - If the port is not an output, or if the token to be sent cannot be converted to the type of this port, or if the token is null.

NoRoomException - If there is no room in the receiver. This should not occur in the DE domain.

send

public void send(int channelIndex,
                 Token[] tokenArray,
                 int vectorLength)
          throws IllegalActionException,
                 NoRoomException

Override the base class to delegate to the wireless channel if the port is outside wireless. If there is no outside channel, then defer to the base class.

Overrides:

send in class TypedIOPort

Parameters:

channelIndex - The index of the channel, from 0 to width-1 If there is an outside channel, then this argument is ignored.

tokenArray - The token array to send

vectorLength - The number of elements of the token array to send.

Throws:

NoRoomException - If there is no room in the receiver.

IllegalActionException - If the tokens to be sent cannot be converted to the type of this port, or if the vectorLength argument is greater than the length of the tokenArray argument.

sendClear

public void sendClear(int channelIndex)
               throws IllegalActionException

Override the base class to delegate to the wireless channel if the port is outside wireless. If there is no outside channel, then defer to the base class.

Overrides:

sendClear in class IOPort

Parameters:

channelIndex - The index of the channel, from 0 to width-1. If there is an outside channel, then this argument is ignored.

Throws:

IllegalActionException - If a receiver does not support clear().

See Also:

IOPort.broadcastClear(), IOPort.sendClearInside(int)

sendClearInside

public void sendClearInside(int channelIndex)
                     throws IllegalActionException

Override the base class to delegate to the wireless channel if the port is inside wireless. If there is no inside channel, then defer to the base class.

Overrides:

sendClearInside in class IOPort

Parameters:

channelIndex - The index of the channel, from 0 to width-1. If there is an inside channel, then this argument is ignored.

Throws:

IllegalActionException - If a receiver does not support clear().

See Also:

IOPort.sendClear(int)

sendInside

public void sendInside(int channelIndex,
                       Token token)
                throws IllegalActionException,
                       NoRoomException

Override the base class to delegate to the wireless channel if the port is inside wireless. If there is no inside channel, then defer to the base class.

Overrides:

sendInside in class TypedIOPort

Parameters:

channelIndex - The index of the channel, from 0 to width-1. If there is an inside channel, then this argument is ignored.

token - The token to send

Throws:

NoRoomException - If there is no room in the receiver.

IllegalActionException - If conversion to the type of the destination port cannot be done.

sinkPortList

public java.util.List sinkPortList()

Return a list of the ports that can potentially accept data from this port when it sends on the outside. If the port is outside wireless, then this includes only the channel port. Otherwise, this includes opaque input ports that are connected on the outside to this port and opaque output ports that are connected on the inside to this one.

Overrides:

sinkPortList in class IOPort

Returns:

A list of IOPort objects.

See Also:

IOPort.getRemoteReceivers()

sourcePortList

public java.util.List sourcePortList()

Return a list of the ports that can potentially send data to this port from the outside. If the port is outside wireless, then this includes only the channel port. Otherwise, this includes opaque output ports that are connected on the outside to this port and opaque input ports that are connected on the inside to this one.

Overrides:

sourcePortList in class IOPort

Returns:

A list of IOPort objects.

_insideIsWireless

protected boolean _insideIsWireless()

Return true if the port is inside wireless.

Returns:

True if the inside is wireless.

_outsideIsWireless

protected boolean _outsideIsWireless()

Return true if the port is outside wireless.

Returns:

True if the outside is wireless.