RtjAocsFramework.TelemetryManagement
Interface TelemetryStream

All Known Implementing Classes:

JbedSmmTelemetryStream, TestTelemetryStream

public interface TelemetryStream

Interface implemented by telemetry streams. The term telemetry stream is used to designate the physical entity to which telemetry is written. In most cases, this is a memory buffer where telemetry data are to be copied and from which dedicated hardware will then transfer them in DMA mode to the system bus. In other implementations, the telemetry stream could be an I/O port directly connected to the system bus interface. A telemtry stream thus represents the data sink to which telemetry data are written.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

See Also:

The Telemetry Management Framelet Document.

Method Summary

void	flushBuffer() Flush the current telemetry frame to the telemetry stream
int	getBufferSize() Return the size of the telemetry buffer in bytes
void	resetBuffer() Reset the telemetry buffer
void	setBufferSize(int size) Set the size of the telemetry buffer in bytes.
void	write(boolean d) Write the boolean 'd' to the telemetry stream
void	write(byte d, int n, int m) Write bits n to m of byte 'd' to the telemetry stream
void	write(double d) Write the double 'd' to the telemetry stream
void	write(float d) Write the float 'd' to the telemetry stream
void	write(int d) Write the integer 'd' to the telemetry stream
void	write(int address, int n) Write to telemetry stream n bytes starting from address 'address'
void	write(int d, int n, int m) Write bits n to m of integer 'd' to the telemetry stream
void	write(short d) Write the short integer 'd' to the telemetry stream
void	write(short d, int n, int m) Write bits n to m of short 'd' to the telemetry stream
void	writeFrameNumber(int n) Write the telemetry frame number to the telemetry stream.
void	writeNumberOfBits(int n) Write the number of bits in the current frame to the telemetry stream.
void	writeNumberOfBytes(int n) Write the number of bytes in the current frame to the telemetry stream.

Method Detail

writeFrameNumber

public void writeFrameNumber(int n)

Write the telemetry frame number to the telemetry stream. A telemetry frame is a set of telemetry data that are sent to the telemetry stream at the same time. The method is provided for the case when the telemetry frame number must be written to a particular location in the telemetry image.

Parameters:

n - the telemetry frame number.

writeNumberOfBytes

public void writeNumberOfBytes(int n)

Write the number of bytes in the current frame to the telemetry stream. The method is provided for the case when the telemetry frame number must be written to a particular location in the telemetry image.

Parameters:

n - the number of bytes in the current telemetry frame.

writeNumberOfBits

public void writeNumberOfBits(int n)

Write the number of bits in the current frame to the telemetry stream. The method is provided for the case when: a) the telemetry frame number must be written to a particular location in the telemetry image b) bits and bytes are written to separate locations.

Parameters:

n - the number of bits that were written using bit writing methods. The bit writing methods are those that write individual bits to the telemetry stream.

write

public void write(int address,
                  int n)

Write to telemetry stream n bytes starting from address 'address'

write

public void write(double d)

Write the double 'd' to the telemetry stream

write

public void write(float d)

Write the float 'd' to the telemetry stream

write

public void write(int d)

Write the integer 'd' to the telemetry stream

write

public void write(short d)

Write the short integer 'd' to the telemetry stream

write

public void write(boolean d)

Write the boolean 'd' to the telemetry stream

write

public void write(int d,
                  int n,
                  int m)

Write bits n to m of integer 'd' to the telemetry stream

write

public void write(short d,
                  int n,
                  int m)

Write bits n to m of short 'd' to the telemetry stream

write

public void write(byte d,
                  int n,
                  int m)

Write bits n to m of byte 'd' to the telemetry stream

flushBuffer

public void flushBuffer()

Flush the current telemetry frame to the telemetry stream

resetBuffer

public void resetBuffer()

Reset the telemetry buffer

getBufferSize

public int getBufferSize()

Return the size of the telemetry buffer in bytes

setBufferSize

public void setBufferSize(int size)

Set the size of the telemetry buffer in bytes. This is an initialization method.