CCSDS_telemetryPrint.h File Reference

Print routines to telemetry packets. More...

Typedefs
typedef struct _CCSDS_telemetry	CCSDS_telemetry
typedef enum _CCSDS_TELEMETRY_PRINT_OPTS_V	CCSDS_TELEMETRY_PRINT_OPTS_V
	Typedef for enum _CCSDS_TELEMETRY_PRINT_OPTS_V.
typedef enum _CCSDS_TELEMETRY_PRINT_OPTS_M	CCSDS_TELEMETRY_PRINT_OPTS_M
	Typedef for enum _CCSDS_TELEMETRY_PRINT_OPTS_M.
Enumerations
enum	_CCSDS_TELEMETRY_PRINT_OPTS_V {   CCSDS_TELEMETRY_PRINT_OPTS_V_TITLE = 0,   CCSDS_TELEMETRY_PRINT_OPTS_V_HEADER = 1,   CCSDS_TELEMETRY_PRINT_OPTS_V_TIME = 2 }
	Options to CCSDS_telemetryPrint, right shift values. More...
enum	_CCSDS_TELEMETRY_PRINT_OPTS_M {   CCSDS_TELEMETRY_PRINT_OPTS_M_TITLE,   CCSDS_TELEMETRY_PRINT_OPTS_M_HEADER,   CCSDS_TELEMETRY_PRINT_OPTS_M_TIME,   CCSDS_TELEMETRY_PRINT_OPTS_M_HEADER_TIME,   CCSDS_TELEMETRY_PRINT_OPTS_M_ALL }
	Options to CCSDS_telemetryPrint, in place masks. More...
Functions
void	CCSDS_telemetryPrintStatus (const CCSDS_telemetry *packet, unsigned int status)
	Reports on the verification status.
void	CCSDS_telemetryPrintTitle (void)
	Prints the telemetry title line. Generally this is printed once, then followed by a series of packet header information lines.
void	CCSDS_telemetryPrint (const CCSDS_telemetry *packet, unsigned int options)
	Used to print the information about a CCSDS packet.

---

Detailed Description

Print routines to telemetry packets.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: CCSDS_telemetryPrint.h,v 1.3 2009/03/28 16:09:36 russell Exp $

---

Enumeration Type Documentation

enum _CCSDS_TELEMETRY_PRINT_OPTS_M

Options to CCSDS_telemetryPrint, in place masks.

Enumerator:

CCSDS_TELEMETRY_PRINT_OPTS_M_TITLE	Print title line
CCSDS_TELEMETRY_PRINT_OPTS_M_HEADER	Print the packet header without the time
CCSDS_TELEMETRY_PRINT_OPTS_M_TIME	Print the packet time
CCSDS_TELEMETRY_PRINT_OPTS_M_HEADER_TIME	Print the packet header plus the ASCII formatted time
CCSDS_TELEMETRY_PRINT_OPTS_M_ALL	Print everything

enum _CCSDS_TELEMETRY_PRINT_OPTS_V

Options to CCSDS_telemetryPrint, right shift values.

Enumerator:

CCSDS_TELEMETRY_PRINT_OPTS_V_TITLE	Print title line
CCSDS_TELEMETRY_PRINT_OPTS_V_HEADER	Print the packet time
CCSDS_TELEMETRY_PRINT_OPTS_V_TIME	Print the packet time

---

Function Documentation

void CCSDS_telemetryPrint	(	const CCSDS_telemetry *	packet,
		unsigned int	options
	)

Used to print the information about a CCSDS packet.

Parameters:

	packet	The CCSDS packet.
	options	Print options presented as the OR of the values found in CCSDS_TELEMETRY_PRINT_OPTS_M

See also:

CCSDS_TELEMETRY_PRINT_OPTS_M

Typically one would specify CCSDS_TELEMETRY_PRINT_OPTS_M_TITLE on the the first of a series of packets along with CCSDS_TELEMETRY_PRINT_OPTS_M_HEADER and/or CCSDS_TELEMETRY_PRINT_OPTS_TIME. Subsequent calls would omit the TITLE option.

This will produce a series of columns, this the TITLE line providing the name of the information in each column.

References CCSDS_TELEMETRY_PRINT_OPTS_M_HEADER, CCSDS_TELEMETRY_PRINT_OPTS_M_TIME, CCSDS_TELEMETRY_PRINT_OPTS_M_TITLE, and CCSDS_telemetryPrintTitle().

Referenced by CCSDS_istreamHdrPrint(), and CCSDS_istreamPktCheck().

void CCSDS_telemetryPrintStatus	(	const CCSDS_telemetry *	packet,
		unsigned int	status
	)

Reports on the verification status.

Returns:

The input status

Parameters:

	packet	The telemetry packet
	status	The verification status

References CCSDS__telemetrySecondaryFlag(), CCSDS__telemetryType(), CCSDS__telemetryVersion(), CCSDS_HEADER_TYPE_K_TELEMETRY, CCSDS_TELEMETRY_VERSION_K_EXPECTED, CCSDS_VERIFY_ERR_M_SECONDARY, CCSDS_VERIFY_ERR_M_TYPE, and CCSDS_VERIFY_ERR_M_VERSION.

void CCSDS_telemetryPrintTitle

(

void

)

Prints the telemetry title line. Generally this is printed once, then followed by a series of packet header information lines.

This routine is what is called when CCSDS_telemetryPrint is called with the CCSDS_TELEMETRY_PRINT_OPTS_M_TITLE option selected. It is broken out for convenience.

Referenced by CCSDS_telemetryPrint().