DC_FileTelemetryStream Class Reference

#include <DC_FileTelemetryStream.h>

Inheritance diagram for DC_FileTelemetryStream:

List of all members.

Detailed Description

File-oriented telemetry stream.

The data written to the telemetry stream are written to an output file. The output file can be either a named file or the standard output. This will allow usage both in a desktop environment and in many embedded environments. This type of telemetry stream is primarily intended for testing purposes.

Author:: Alessandro Pasetti (P&P Software GmbH)

Version:: 1.0

Definition at line 29 of file DC_FileTelemetryStream.h.

Public Member Functions

DC_FileTelemetryStream (void)

Instantiate a file telemetry stream component.

void setOutputStream (FILE *outputStream)

Set the output stream to which the telemetry data are written and write a header to the output stream.

FILE * getOutputStream (void)

Return the output stream to which the telemetry data are written.

virtual void flush (void)

Write an "end-of-TM-frame" message to the output stream and flush it.

virtual void write (TelemetryPacket *tmItem)

Write the full content of the telemetry packet to the output stream.

Constructor & Destructor Documentation

DC_FileTelemetryStream::DC_FileTelemetryStream ( void )

Instantiate a file telemetry stream component.
This constructor sets the the class identifier.
Definition at line 20 of file DC_FileTelemetryStream.cpp.

Member Function Documentation

void DC_FileTelemetryStream::flush ( void ) [virtual]

Write an "end-of-TM-frame" message to the output stream and flush it.
The "end-of-TM-frame" message consists of a single straight line. If the output stream is the standard output, no action is taken.
Reimplemented from TelemetryStream.
Definition at line 25 of file DC_FileTelemetryStream.cpp.

FILE * DC_FileTelemetryStream::getOutputStream ( void )

Return the output stream to which the telemetry data are written.
The return value can be pNULL to signify that the output stream is the standard ouptut.
Returns:
the ouptut file or pNULL if the telemetry data must be written to the standard output

Definition at line 46 of file DC_FileTelemetryStream.cpp.

void DC_FileTelemetryStream::setOutputStream ( FILE * outputStream )

Set the output stream to which the telemetry data are written and write a header to the output stream.
If the argument is pNULL, then the output stream is assumed to be the standard ouptut.
Parameters:

outputStream the ouptut file or pNULL if the telemetry data must be written to the standard output

Definition at line 34 of file DC_FileTelemetryStream.cpp.

void DC_FileTelemetryStream::write ( TelemetryPacket * tmItem ) [virtual]

Write the full content of the telemetry packet to the output stream.
First, the value of all the attributes (the telemetry time tag, the telemetry type and subtype, the telemetry destination) are written. Then the telemetry packet data are written as a sequence of bytes.
Parameters:

tmItem the telemetry packet to be written to the output stream.

Implements TelemetryStream.
Definition at line 50 of file DC_FileTelemetryStream.cpp.

The documentation for this class was generated from the following files:


Public Member Functions
	DC_FileTelemetryStream (void)
	Instantiate a file telemetry stream component.
void	setOutputStream (FILE *outputStream)
	Set the output stream to which the telemetry data are written and write a header to the output stream.
FILE *	getOutputStream (void)
	Return the output stream to which the telemetry data are written.
virtual void	flush (void)
	Write an "end-of-TM-frame" message to the output stream and flush it.
virtual void	write (TelemetryPacket *tmItem)
	Write the full content of the telemetry packet to the output stream.