gov.nasa.gsfc.drl.rtstps.core.xstps.pds
Class PdsOutput

java.lang.Object
  extended by gov.nasa.gsfc.drl.rtstps.core.RtStpsNode
      extended by gov.nasa.gsfc.drl.rtstps.core.xstps.pds.PdsOutput
All Implemented Interfaces:
PacketReceiver, Receiver, java.lang.Cloneable

public final class PdsOutput
extends RtStpsNode
implements PacketReceiver, java.lang.Cloneable

This RT-STPS node is a java version of the Sorcerer program. It creates Terra and Aqua PDS or EDS files.


Field Summary
private  Appid[] apList
           
static java.lang.String CLASSNAME
          This is the class name for this RT-STPS node type, which is also the element name.
private static java.lang.String commonTimestamp
           
private  java.lang.StringBuffer constructionRecordName
           
private  PacketKernel current
           
private  PacketKernel firstPacket
           
private  boolean flushActive
           
private  boolean isPDS
           
private  boolean isQuicklookTypeEDS
           
private  PacketKernel lastPacket
           
private  int major
           
private  int minor
           
private  OutputFiles output
           
private  LongStatusItem packetsWritten
           
private  int spid
           
private  boolean test
           
private  long totalBytes
           
private  int totalPackets
           
 
Fields inherited from class gov.nasa.gsfc.drl.rtstps.core.RtStpsNode
linkName, statusItemList, typeName
 
Constructor Summary
PdsOutput()
          A null constructor.
 
Method Summary
private  java.lang.StringBuffer createFileName(org.w3c.dom.Element element)
          Create a PDS/EDS file name for the construction record.
 void finishSetup(Configuration configuration)
          Finish the setup.
 void flush()
          The session is over.
 void load(org.w3c.dom.Element element, Configuration configuration)
          Configure from an XML document.
 void putPacket(Packet packet)
          Give a packet to this PacketReceiver.
 void putPackets(Packet[] packets)
          Give an array of packets to this PacketReceiver.
 
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.ccsds.PacketReceiver
getLinkName
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
This is the 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

flushActive

private boolean flushActive

commonTimestamp

private static java.lang.String commonTimestamp

apList

private Appid[] apList

totalPackets

private int totalPackets

totalBytes

private long totalBytes

output

private OutputFiles output

major

private int major

minor

private int minor

spid

private int spid

test

private boolean test

isPDS

private boolean isPDS

constructionRecordName

private java.lang.StringBuffer constructionRecordName

isQuicklookTypeEDS

private boolean isQuicklookTypeEDS

packetsWritten

private LongStatusItem packetsWritten

firstPacket

private PacketKernel firstPacket

lastPacket

private PacketKernel lastPacket

current

private PacketKernel current
Constructor Detail

PdsOutput

public PdsOutput()
A null constructor.

Method Detail

load

public void load(org.w3c.dom.Element element,
                 Configuration configuration)
          throws RtStpsException
Configure from an XML document. You cannot assume that any other stps nodes have been created.

Specified by:
load in class RtStpsNode
Throws:
RtStpsException

finishSetup

public void finishSetup(Configuration configuration)
                 throws RtStpsException
Finish the setup. When this method is called, you may assume all nodes have been created and exist by name in the map, and all standard links have been resolved. This is a last chance to prepare for data flow.

Specified by:
finishSetup in class RtStpsNode
Throws:
RtStpsException

createFileName

private java.lang.StringBuffer createFileName(org.w3c.dom.Element element)
                                       throws RtStpsException
Create a PDS/EDS file name for the construction record.

Throws:
RtStpsException

putPackets

public void putPackets(Packet[] packets)
                throws RtStpsException
Give an array of packets to this PacketReceiver.

Specified by:
putPackets in interface PacketReceiver
Throws:
RtStpsException

putPacket

public void putPacket(Packet packet)
               throws RtStpsException
Give a packet to this PacketReceiver.

Specified by:
putPacket in interface PacketReceiver
Throws:
RtStpsException

flush

public void flush()
           throws RtStpsException
The session is over. Create the construction record file.

Specified by:
flush in interface PacketReceiver
Specified by:
flush in interface Receiver
Throws:
RtStpsException