RtjAocsFramework.TelemetryManagement
Interface Telemeterable

All Known Implementing Classes:

AocsEvent, AocsObject

public interface Telemeterable

Interface implemented by all telemeterable objects. A telemerable object is an object that is capable of writing its own state to the telemetry stream. The telemetry data are conceptualized as an image of (a subset of) the state of selected objects in the on-board software. A telemeterable object is thus conceptually similar to a serializable object in Java and telemetry is treated by the framework as a form of serialization.

The basic method in the interface is writeToTelemetry() that causes the object to write itself to a telemetry stream. This method insulates the management of the telemetry process from the structure of the telemetry data of each particular object: it confines the information about which data are to be sent to telemetry by each object to the object itself and thus allows the management of the telemetry process to be done in a generic manner.

The type of information that an object sends to telemetry is defined internally to the object itself by the way it implements the writeToTelemetry() method. Some control over the quantity of telemetry information is provided by the telemetry format. Telemetry formats are represented by an integer constant. The following formats are foreseen: short, normal, long, and debugging. Not all objects implement all formats. Thus the only thing that can be said with certainty about telemetry formats is that: the short format does not produce more data than the normal format; that the normal format does not produce more data than the long format; etc. Note that the telemetry format is a property of each telemetry object, not of the telemetry manager or of the telemetry frame. Hence, the same telemetry frame can include objects with different telemetry formats.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

See Also:

The Telemetry Management Framelet Document.

Field Summary

static byte	DEBUG_TM
static byte	LONG_TM
static byte	NORMAL_TM
static byte	NTMFORMATS
static byte	SHORT_TM

Method Summary

byte	getTelemetryFormat() Return the current telemetry format.
int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
void	setTelemetryFormat(byte newFormat) Set the telemetry format to 'newFormat'.
void	writeToTelemetry(TelemetryStream stream) Direct the object to write its own state to the telemetry stream.

Field Detail

NTMFORMATS

public static final byte NTMFORMATS

See Also:

Constant Field Values

SHORT_TM

public static final byte SHORT_TM

See Also:

Constant Field Values

NORMAL_TM

public static final byte NORMAL_TM

See Also:

Constant Field Values

LONG_TM

public static final byte LONG_TM

See Also:

Constant Field Values

DEBUG_TM

public static final byte DEBUG_TM

See Also:

Constant Field Values

Method Detail

writeToTelemetry

public void writeToTelemetry(TelemetryStream stream)

Direct the object to write its own state to the telemetry stream.

setTelemetryFormat

public void setTelemetryFormat(byte newFormat)

Set the telemetry format to 'newFormat'.

getTelemetryFormat

public byte getTelemetryFormat()

Return the current telemetry format.

getTelemetryImageLength

public int getTelemetryImageLength()

Return the length (in bits) of the telemetry image of the object. This method is useful to verify that the quantity of data generated by a given object is compatible with the capacity of the telemetry channel.