Terrenus HRPT v2.2

terrenus.telemetry
Interface TelemetryStream

All Known Implementing Classes:
AbstractTelemetryStream, CHRPTStream, CMA1A5CHRPTStream, CMA1A5HRPTStream, GlobalHRPTStream, HRPTStream, NOAA1bHRPTStream, QuorumCHRPTStream, QuorumHRPTStream, RawCHRPTStream, RawHRPTStream, TeraScanCHRPTStream, TeraScanHRPTStream, TeraScanSwapHRPTStream

public interface TelemetryStream

A TelemetryStream is a sequence of data values broadcast by a spacecraft. Telemetry data consists of a series of data frames of some fixed length. Each frame contains a number of blocks of data. A stream object provides a decoder that allows for useful operations on the data.


Method Summary
 java.nio.ByteBuffer getBlock(int frame, int block)
          Gets the data for the specified block.
 int getBlockCount()
          Gets the number of blocks per frame.
 int getDayCount()
          Gets the starting day count, or -1 if not available.
 TelemetryDecoder getDecoder()
          Gets a decoder for the stream data.
 java.lang.String getFormat()
          Gets a description of the underlying data format.
 int getFrameCount()
          Gets the total number of telemetry frames.
 int getYear()
          Gets the starting year, or -1 if not available.
 void setDayCount(int dayCount)
          Sets the starting day count.
 void setYear(int year)
          Sets the starting year.
 

Method Detail

getFrameCount

int getFrameCount()
Gets the total number of telemetry frames.


getYear

int getYear()
            throws java.io.IOException
Gets the starting year, or -1 if not available.

Throws:
java.io.IOException

setYear

void setYear(int year)
Sets the starting year. This may be needed if the year cannot be detected from the stream.

Parameters:
year - the starting year. The year is returned by the next call to getYear().

getDayCount

int getDayCount()
                throws java.io.IOException
Gets the starting day count, or -1 if not available.

Throws:
java.io.IOException

setDayCount

void setDayCount(int dayCount)
Sets the starting day count. This may be needed if the day count cannot be detected from the stream.

Parameters:
dayCount - the starting day count. The day count is returned by the next call to getDayCount().

getFormat

java.lang.String getFormat()
Gets a description of the underlying data format.


getDecoder

TelemetryDecoder getDecoder()
                            throws java.io.IOException
Gets a decoder for the stream data.

Throws:
java.io.IOException - if an error occurred decoding the stream data.

getBlockCount

int getBlockCount()
Gets the number of blocks per frame.


getBlock

java.nio.ByteBuffer getBlock(int frame,
                             int block)
Gets the data for the specified block.

Parameters:
frame - the frame to get data.
block - the block number to get data.
Returns:
the block data buffer.

Terrenus HRPT v2.2