|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Interface for wireless channels in the wireless domain. Wireless channels are special components in a wireless model. They are used to determine the connectivity and deliver tokens from the transmitter to receiver(s). This interface defines a set of methods for the wireless channel components.
The transmitter can call the channel's transmit() method to deliver data to its corresponding receivers. It can specify the transmission properties by a record token including the transmission range, transmission power. The transmit properties may be modified by the channel model or by some property transformers(@see PropertyTransformer) during the transmission to take into account channel losses, antenna gain, noise, etc.
| Yellow (cxh) |
| Green (cxh) |
| Field Summary |
| Fields inherited from interface ptolemy.actor.Executable |
COMPLETED, NOT_READY, STOP_ITERATING |
| Method Summary | |
ChannelPort |
getChannelPort()
Return a channel port that can be used to set type constraints between senders and receivers. |
java.util.List |
listeningInputPorts()
Return a list of input ports that can potentially receive data from this channel. |
java.util.List |
listeningOutputPorts()
Return a list of output ports that can potentially receive data from this channel. |
void |
registerPropertyTransformer(PropertyTransformer transformer,
WirelessIOPort port)
Register a property transformer for transmissions from the specified port. |
java.util.List |
sendingInputPorts()
Return a list of input ports that can potentially send data to this channel. |
java.util.List |
sendingOutputPorts()
Return a list of output ports that can potentially send data to this channel. |
void |
transmit(ptolemy.data.Token token,
WirelessIOPort port,
ptolemy.data.RecordToken properties)
Transmit the specified token from the specified port with the specified properties. |
void |
unregisterPropertyTransformer(PropertyTransformer transformer,
WirelessIOPort port)
Unregister a property transformer for transmissions from the specified port (or from null for a generic property transformer). |
| Methods inherited from interface ptolemy.actor.Actor |
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList |
| Methods inherited from interface ptolemy.actor.Executable |
fire, initialize, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup |
| Methods inherited from interface ptolemy.kernel.util.Nameable |
description, getContainer, getFullName, getName, getName, setName |
| Methods inherited from interface ptolemy.domains.wireless.kernel.PropertyTransformer |
transformProperties |
| Method Detail |
public ChannelPort getChannelPort()
public java.util.List listeningInputPorts()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If a port is encountered
whose outsideChannel parameter cannot be evaluated.
public java.util.List listeningOutputPorts()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If a port is encountered
whose insideChannel parameter cannot be evaluated.
public void registerPropertyTransformer(PropertyTransformer transformer,
WirelessIOPort port)
transformer - The property transformer to be registered.port - The port whose transmissions should be subject to the
property transformer, or null to make them subject to all
transmissions through this channel.
public java.util.List sendingInputPorts()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If a port is encountered
whose insideChannel parameter cannot be evaluated.
public java.util.List sendingOutputPorts()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If a port is encountered
whose outsideChannel parameter cannot be evaluated.
public void transmit(ptolemy.data.Token token,
WirelessIOPort port,
ptolemy.data.RecordToken properties)
throws ptolemy.kernel.util.IllegalActionException
token - The token to transmit, or null to clear all
receivers that are in range.port - The port from which this is being transmitted.properties - The transmission properties.
ptolemy.kernel.util.IllegalActionException - If something goes wrong during
the transmission.
public void unregisterPropertyTransformer(PropertyTransformer transformer,
WirelessIOPort port)
transformer - The property transformer to be unregistered.port - The port whose transmissions should be subject to the
property transformer, or null for a generic transformer.registerPropertyTransformer(PropertyTransformer, WirelessIOPort)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||