
WirelessIOPort |
ptolemy.domains.wireless.kernel.WirelessIOPort |
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
<i>outsideChannel</i> or <i>insideChannel</i> parameter.
<p>
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.
<p>
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.
<p>
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.
<p>
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.
Author(s): Edward A. Lee and Xiaojun Liu
Version:$Id: WirelessIOPort.doc.html,v 1.1 2006/02/22 18:42:26 mangal Exp $
Pt.Proposed Rating:Green (cxh)
Pt.Accepted Rating:Yellow (cxh)
insideChannel
The name of the inside channel. This is a string that defaults to
the empty string, indicating that communication is not wireless.
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
The name of the outside channel. This is a string that defaults to
the empty string, indicating that communication is not wireless.
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.