QPIG_print.c File Reference

Functions to retrieve the PIG state data from a datagram. More...

#include <QPIG_p.h>
#include <QPIG/QPIG.h>
#include <DUMP/dump.h>
#include <LSF/LSF.h>
#include <LSF/LSF_ids.h>
#include <LSF/LSF_scan.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Classes
struct	_Ctl
	Run time print options/parameters. More...
Typedefs
typedef struct _Ctl	Ctl
	Run time print options/parameters.
Functions
static void	report_usage (void)
	Brief explanation on qpig_print usage.
static int	get_ctl (Ctl *ctl, int argc, char *const argv[])
	Get the command line parameters.
static LSF_scanContributionHandler	print_dgm (ApidStream *astream, const LSF_datagram *dgm)
	Process PIG register state datagrams.
static void	new_line (void)
	Print a new line.
int	QPIG_print (int argc, char *const argv[])
	Process a file of PIG register state datagrams.
int	main (int argc, char *const argv[])
	Main program to process a file of PIG register state datagrams.

---

Detailed Description

Functions to retrieve the PIG state data from a datagram.

Author:

James Swain & Owen Saxton

Id

QPIG_print.c,v 1.7 2011/03/29 20:29:25 saxton Exp

---

Function Documentation

static int get_ctl	(	Ctl *	ctl,
		int	argc,
		char *const	argv[]
	)			[static]

Get the command line parameters.

This routine examines the command line parameters and fills the print run time options control structure.

Parameters:

	ctl	The parameter run time options block.
	argc	The number of command line parameters.
	argv	The array of pointers to the command line parameters.

Return values:

	0	Everything is okay.
	-1	Incorrect command usage. Usually this means that the input file name was absent.

References _Ctl::dmp_ccsds, _Ctl::file, and report_usage().

Referenced by QPIG_print().

int main	(	int	argc,
		char *const	argv[]
	)

Main program to process a file of PIG register state datagrams.

Parameters:

	argc	The argument count
	argv	The vector of command line strings

Returns:

Overall status

References QPIG_print().

static void new_line

(

void

)

[static]

Print a new line.

Referenced by print_dgm().

LSF_scanContributionHandler print_dgm	(	ApidStream *	astream,
		const LSF_datagram *	dgm
	)			[static]

Process PIG register state datagrams.

Parameters:

	astream	The APID stream
	dgm	The datagram

Returns:

Either a stop scan signal or the contribution handler

References new_line(), and _Ctl::qpig.

Referenced by QPIG_print().

int QPIG_print	(	int	argc,
		char *const	argv[]
	)

Process a file of PIG register state datagrams.

Parameters:

	argc	The argument count
	argv	The vector of command line strings

Returns:

Overall status

References _Ctl::dmp_ccsds, _Ctl::file, get_ctl(), print_dgm(), and _Ctl::qpig.

Referenced by main().

static void report_usage

(

void

)

[static]

Brief explanation on qpig_print usage.

Referenced by get_ctl().