gov.nasa.gsfc.drl.rtstps.core
Class FrameOutputTool

java.lang.Object
  extended by gov.nasa.gsfc.drl.rtstps.core.FrameOutputTool

public class FrameOutputTool
extends java.lang.Object

An RT-STPS node that sends frames to receivers uses this utility to construct the output object. The utility disguises the fact that the output may be more than one receiver. It also guarantees that all receivers accept frames.


Field Summary
private  FrameBroadcaster broadcaster
           
private  java.lang.String name
           
private  FrameReceiver output
           
 
Constructor Summary
FrameOutputTool(java.lang.String name)
          Create the frame receiver tool.
 
Method Summary
 void addOutput(FrameReceiver r)
          Add a FrameReceiver object to the output list.
 void addReceiver(Receiver r)
          Add a receiver to the output list.
 FrameReceiver getOutput()
          Get the constructed frame receiver.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

output

private FrameReceiver output

broadcaster

private FrameBroadcaster broadcaster

name

private java.lang.String name
Constructor Detail

FrameOutputTool

public FrameOutputTool(java.lang.String name)
Create the frame receiver tool.

Parameters:
name - A name, which is usually the client's name, used in error messages.
Method Detail

addOutput

public void addOutput(FrameReceiver r)
Add a FrameReceiver object to the output list.


addReceiver

public void addReceiver(Receiver r)
                 throws RtStpsException
Add a receiver to the output list.

Parameters:
r - If the receiver is not of the expected type, then the method throws an exception.
Throws:
RtStpsException

getOutput

public FrameReceiver getOutput()
Get the constructed frame receiver.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object