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

java.lang.Object
  extended by gov.nasa.gsfc.drl.rtstps.core.RtStpsNode
      extended by gov.nasa.gsfc.drl.rtstps.core.FrameSenderNode
          extended by gov.nasa.gsfc.drl.rtstps.core.FrameStatus
All Implemented Interfaces:
FrameReceiver, Receiver, Sender, java.lang.Cloneable

public class FrameStatus
extends FrameSenderNode
implements FrameReceiver, Sender, java.lang.Cloneable

This class holds Frame level status. It is also a FrameReceiver, so you may plug it into a pipeline. It examines frame annotation for each frame and counts occurrences. You do not have to set an output FrameReceiver, in which case it becomes a terminal.


Field Summary
static java.lang.String CLASSNAME
          This is a class name for this RT-STPS node type, which is also the element name.
private  LongStatusItem crcErrors
          The number of frames that have CRC errors.
private  LongStatusItem deleted
          The number of frames marked for deletion.
private  LongStatusItem flywheels
          The number of transmitted flywheel frames.
private  LongStatusItem invertedFrames
          The number of inverted frames the Frame Synchronizer detected.
private  LongStatusItem locks
          The number of lock frames.
private  LongStatusItem passed
          The number of passed frames, i.e.
private  LongStatusItem rsCorrected
          The number of frames that had Reed Solomon errors, which were corrected.
private  LongStatusItem rsUncorrectables
          The number of frames that had Reed Solomon uncorrectable errors.
private  LongStatusItem slips
          The number of slip frames.
private  LongStatusItem trueFrames
          The number of true frames the Frame Synchronizer detected.
 
Fields inherited from class gov.nasa.gsfc.drl.rtstps.core.FrameSenderNode
output
 
Fields inherited from class gov.nasa.gsfc.drl.rtstps.core.RtStpsNode
linkName, statusItemList, typeName
 
Constructor Summary
FrameStatus()
          Create a FrameStatus node.
 
Method Summary
 void count(Frame frame)
          Count occurrences of the frame's annotation fields.
 void load(org.w3c.dom.Element element, Configuration config)
          Set up this RT-STPS node with a configuration.
 void putFrame(Frame frame)
          Give a frame to this FrameReceiver.
 void putFrames(Frame[] frames)
          Give an array of frames to this FrameReceiver.
 
Methods inherited from class gov.nasa.gsfc.drl.rtstps.core.FrameSenderNode
addReceiver, finishSetup, flush, setOutputIsRequired
 
Methods inherited from class gov.nasa.gsfc.drl.rtstps.core.RtStpsNode
clear, clone, getElementName, getLinkName, getStatusItems, setLinkName, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nasa.gsfc.drl.rtstps.core.FrameReceiver
flush, getLinkName
 
Methods inherited from interface gov.nasa.gsfc.drl.rtstps.core.Sender
addReceiver
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
This is a class name for this RT-STPS node type, which is also the element name. It is not necessarily the link name, which is the name of one particular object.

See Also:
Constant Field Values

locks

private LongStatusItem locks
The number of lock frames.


flywheels

private LongStatusItem flywheels
The number of transmitted flywheel frames.


slips

private LongStatusItem slips
The number of slip frames. Slip frames are ones that the Frame Synchronizer found out of position (long or short) by 1 or 2 bits.


invertedFrames

private LongStatusItem invertedFrames
The number of inverted frames the Frame Synchronizer detected.


trueFrames

private LongStatusItem trueFrames
The number of true frames the Frame Synchronizer detected. Frames will originally be either true or inverted.


crcErrors

private LongStatusItem crcErrors
The number of frames that have CRC errors. The frames must contain CRC parity and CRC detection must be enabled for this counter to be meaningful.


rsCorrected

private LongStatusItem rsCorrected
The number of frames that had Reed Solomon errors, which were corrected. The frames must contain Reed Solomon parity and Reed Solomon block correction must be enabled for this counter to be meaningful.


rsUncorrectables

private LongStatusItem rsUncorrectables
The number of frames that had Reed Solomon uncorrectable errors. The frames must contain Reed Solomon parity and Reed Solomon block detection must be enabled for this counter to be meaningful.


deleted

private LongStatusItem deleted
The number of frames marked for deletion.


passed

private LongStatusItem passed
The number of passed frames, i.e. not marked for deletion.

Constructor Detail

FrameStatus

public FrameStatus()
Create a FrameStatus node.

Method Detail

load

public void load(org.w3c.dom.Element element,
                 Configuration config)
          throws RtStpsException
Set up this RT-STPS node with a configuration. It does not have an element, so this required method initializes status only.

Specified by:
load in class FrameSenderNode
Throws:
RtStpsException

putFrames

public void putFrames(Frame[] frames)
               throws RtStpsException
Give an array of frames to this FrameReceiver.

Specified by:
putFrames in interface FrameReceiver
Throws:
RtStpsException

putFrame

public void putFrame(Frame frame)
              throws RtStpsException
Give a frame to this FrameReceiver.

Specified by:
putFrame in interface FrameReceiver
Throws:
RtStpsException

count

public void count(Frame frame)
Count occurrences of the frame's annotation fields.