gov.nasa.gsfc.drl.rtstps.core.fs
Class FsSetup

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

public class FsSetup
extends java.lang.Object

This class defines setup fields that are commonly associated with the Frame Synchronizer component.


Field Summary
 boolean correctInversion
          If true, the synchronizer will correct the polarity of frames that it determines have an inverted sync pattern.
 int flywheelDuration
          If the synchronizer loses sync, then it will flywheel a number of frame lengths equal to the flywheel duration, after which it will then search for sync once again.
 int frameLength
          The frame length in bytes.
 boolean invertedSyncEnabled
          If true, the synchronizer searches for inverted sync patterns.
 boolean isPnEncoded
          If true, it assumes the frames are encoded with bit transition density encoding, and it will decode the frames.
 boolean isSendingFlywheels
          If false, the synchronizer discards flywheel data.
 int slippage
          If 1 or 2, it permits frames to slip long or short 1 or 2 bits respectively.
static int SYNC_PATTERN
           
 int syncLength
          The sync pattern length.
 byte[] syncPattern
          The frame sync pattern.
(package private)  TimeStamp timestamp
          This object contains information to configure the clock that stamps every frame with a time.
 boolean trueSyncEnabled
          If true, the synchronizer searches for true sync patterns.
 
Constructor Summary
FsSetup(org.w3c.dom.Element element)
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SYNC_PATTERN

public static final int SYNC_PATTERN
See Also:
Constant Field Values

syncPattern

public byte[] syncPattern
The frame sync pattern. The array length must be "syncLength" long.


syncLength

public int syncLength
The sync pattern length. It must be 2, 3, or 4 bytes.


frameLength

public int frameLength
The frame length in bytes.


slippage

public int slippage
If 1 or 2, it permits frames to slip long or short 1 or 2 bits respectively. Only choose 0, 1, or 2.


trueSyncEnabled

public boolean trueSyncEnabled
If true, the synchronizer searches for true sync patterns. Either trueSyncEnabled or invertedSyncEnabled (or both) must be enabled.


invertedSyncEnabled

public boolean invertedSyncEnabled
If true, the synchronizer searches for inverted sync patterns. Either trueSyncEnabled or invertedSyncEnabled (or both) must be enabled.


correctInversion

public boolean correctInversion
If true, the synchronizer will correct the polarity of frames that it determines have an inverted sync pattern. It inverts the entire frame and not just the sync pattern. This should always be true if frames are going to the CRC/RS decoders or to the CCSDS services.


flywheelDuration

public int flywheelDuration
If the synchronizer loses sync, then it will flywheel a number of frame lengths equal to the flywheel duration, after which it will then search for sync once again.


isSendingFlywheels

public boolean isSendingFlywheels
If false, the synchronizer discards flywheel data. If true, it treats it as lock frames, eventhough it may not be valid frames. The annotation will mark each flywheel frame as not a lock frame. The synchronizer does not detect inverted data in flywheel frames, so you should probably not send flywheel frames to the decoders or the CCSDS services unless you are certain the input stream does not contain inverted data.


isPnEncoded

public boolean isPnEncoded
If true, it assumes the frames are encoded with bit transition density encoding, and it will decode the frames.


timestamp

TimeStamp timestamp
This object contains information to configure the clock that stamps every frame with a time.

Constructor Detail

FsSetup

public FsSetup(org.w3c.dom.Element element)
        throws RtStpsException
Throws:
RtStpsException