Terrenus HRPT v2.2

terrenus.telemetry
Interface TelemetryDecoder

All Known Implementing Classes:
CHRPTDecoder, HRPTDecoder

public interface TelemetryDecoder

The TelemetryDecoder class uses a TelemetryStream to decode telemetry data from a spacecraft telemetry data stream. The decoder presents a high-level interface for telemetry data, allowing you to make queries on various useful telemetry frame information without the having to resort to manipulating bit fields. The methods of the enclosed TelemetryStream may still be used to access the raw data.


Method Summary
 InstrumentData getData(int frame, Instrument inst)
          Gets the frame data for a specific instrument.
 Spacecraft getSpacecraft()
          Gets the spacecraft detected by this decoder.
 TelemetryStream getStream()
          Gets the telemetry stream used for data.
 long getTime(int frame)
          Gets the start time of frame capture.
 boolean hasErrors(int frame)
          Gets the frame error flag.
 

Method Detail

getStream

TelemetryStream getStream()
Gets the telemetry stream used for data.


getTime

long getTime(int frame)
Gets the start time of frame capture.

Parameters:
frame - the frame to return the time for in the range [0..FRAMES-1].
Returns:
the frame start time in milliseconds since the epoch. The epoch in this case is January 1, 1970 00:00:00 UTC.

hasErrors

boolean hasErrors(int frame)
                  throws java.io.IOException
Gets the frame error flag.

Parameters:
frame - the frame to return the flag for in the range [0..FRAMES-1].
Returns:
the frame error flag, true if errors were detected in the frame data or false if not. Error detection usually consists of checking frame synchronization data and bit parity.
Throws:
java.io.IOException - if an error occurred reading data from the stream.

getSpacecraft

Spacecraft getSpacecraft()
Gets the spacecraft detected by this decoder.


getData

InstrumentData getData(int frame,
                       Instrument inst)
                       throws java.io.IOException
Gets the frame data for a specific instrument.

Parameters:
frame - the frame to return data for in the range [0..FRAMES-1].
inst - the instrument to return data for.
Returns:
the frame data for the specified instrument.
Throws:
java.io.IOException - if an error occurred reading the instrument data from the stream.

Terrenus HRPT v2.2