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

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

public final class Frame
extends Unit

This class contains a single frame.


Field Summary
private  boolean fillFrame
          If true, this frame is defined as a fill or idle frame.
 
Fields inherited from class gov.nasa.gsfc.drl.rtstps.core.Unit
data, deleted, frameAnnotation, length, startOffset
 
Constructor Summary
Frame(int length)
          Create a frame.
 
Method Summary
 boolean isFillFrame()
          Is this a fill frame?
 void reset()
          Reset this object so that it can be used to contain another frame.
 void setFillFrame(boolean fill)
          Mark this frame as a fill frame or not fill frame.
 java.lang.String toString()
          Get debug information.
 
Methods inherited from class gov.nasa.gsfc.drl.rtstps.core.Unit
getData, getFrameAnnotation, getSize, getStartOffset, isDeleted, setDeleted, setFrameAnnotation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fillFrame

private boolean fillFrame
If true, this frame is defined as a fill or idle frame. This is often a CCSDS concept, but it can have meaning for non-CCSDS frames too.

Constructor Detail

Frame

public Frame(int length)
Create a frame.

Parameters:
length - the frame length in bytes
Method Detail

reset

public final void reset()
Reset this object so that it can be used to contain another frame.


isFillFrame

public final boolean isFillFrame()
Is this a fill frame?


setFillFrame

public final void setFillFrame(boolean fill)
Mark this frame as a fill frame or not fill frame. By default, a frame is not a fill frame.


toString

public java.lang.String toString()
Get debug information.

Overrides:
toString in class java.lang.Object