
GetProperties |
ptolemy.domains.wireless.lib.GetProperties |
This actor retrieves the properties most recently received by
an input port that is connected on the inside to the trigger
port of this actor. That port
must be an instance of WirelessIOPort, and must be contained
by the container of this actor, or an exception will be thrown.
A typical usage pattern is inside an instance of WirelessComposite,
to connect the trigger input to the port from which you want to read
the properties.
<p>
NOTE: The type of the properties port is inferred from the
<i>defaultProperties</i> field of the channel used by the connected
port at preinitialize() time. If the connection is changed during
execution, or the connectivity is changed, then the type of the
port will not be updated, and a run-time type error could occur.
Thus, this actor assumes that these types do not change.
If the channel has no default properties (as in the base class
AtomicWirelessChannel), then the type of the properties port will
be undefined. If the output is left disconnected, then this is fine,
but if it is connected, then its type will need to be declared
explicitly.
Author(s): Edward A. Lee
Version:$Id: GetProperties.doc.html,v 1.1 2006/02/22 18:40:27 mangal Exp $
Pt.Proposed Rating:Green (cxh)
Pt.Accepted Rating:Yellow (cxh)
trigger
Port that triggers execution.
output
Port that transmits the properties received on the <i>input</i>
port.