QLMC_read.c File Reference

Routines for reading files of LRA data sent from the LAT. More...

#include <QLMC/QLMC.h>
#include <QLMC/QLMC_msgs.h>
#include <LMC/LMC_pubdefs.h>
#include <LMC/LMC_tlmdefs.h>
#include <QSD/CCSDS_istream.h>
#include <QSD/CCSDS_apidDsc.h>
#include <QSD/CCSDS_telemetry.h>
#include <LSF/LSF.h>
#include <LSF/LSF_ids.h>
#include <MSG/MSG_pubdefs.h>
#include <PBS/BSWP.h>
#include <PBI/Endianness.h>
#include <stdlib.h>
#include <string.h>
#include <fcntl.h>
#include <unistd.h>

Functions
void	QLMC_procDgm (const LSF_datagram *dgm, void *parm, QLMC_calCB calRtn, QLMC_tkrCB tkrRtn, QLMC_acdCB acdRtn, QLMC_deadCB deadRtn)
	Process a datagram.
unsigned	QLMC_readDiag (char *fName, void *parm, QLMC_calCB calRtn, QLMC_tkrCB tkrRtn, QLMC_acdCB acdRtn, QLMC_deadCB deadRtn)
	Read the contents of an LMC packet file.
unsigned	QLMC_readSci (char *fName, void *parm, QLMC_calCB calRtn, QLMC_tkrCB tkrRtn, QLMC_acdCB acdRtn, QLMC_deadCB deadRtn)
	Read the contents of an LMC datagram file.

---

Detailed Description

Routines for reading files of LRA data sent from the LAT.

Author:

Owen H Saxton

Id

QLMC_read.c,v 1.8 2011/03/31 18:49:23 saxton Exp

---

Function Documentation

void QLMC_procDgm	(	const LSF_datagram *	dgm,
		void *	parm,
		QLMC_calCB	calRtn,
		QLMC_tkrCB	tkrRtn,
		QLMC_acdCB	acdRtn,
		QLMC_deadCB	deadRtn
	)

Process a datagram.

This routine processes a complete datagram of LMC data, and calls a user-supplied routine for each type of data record present.

Parameters:

	dgm	The datagram to be processed.
	parm	User parameter to pass to the processing routine.
	calRtn	Routine to call for each LMC calorimeter data record in the datagram. Can be NULL.
	tkrRtn	Routine to call for each LMC tracker data record in the datagram. Can be NULL.
	acdRtn	Routine to call for each LMC ACD data record in the datagram. Can be NULL.
	deadRtn	Routine to call for each LMC deadtime data record in the datagram. Can be NULL.

References _QLMC_acdCount::cnt0, _QLMC_tkrCount::cnt0, _QLMC_calCount::cnt0, _QLMC_deadRecord::cntrs, _QLMC_acdRecord::cntrs, _QLMC_tkrRecord::cntrs, _QLMC_calRecord::cntrs, _QLMC_tkrRecord::pad, _QLMC_calRecord::pad, _QLMC_deadRecord::tenb, and _QLMC_acdCount::tile0.

Referenced by QLMC_readSci().

unsigned QLMC_readDiag	(	char *	fName,
		void *	parm,
		QLMC_calCB	calRtn,
		QLMC_tkrCB	tkrRtn,
		QLMC_acdCB	acdRtn,
		QLMC_deadCB	deadRtn
	)

Read the contents of an LMC packet file.

This routine reads a file of LMC diagnostic data returned from the LAT and calls a user-supplied processing routine for each type of data record found.

Parameters:

	fName	The name of the file to be processed
	parm	User parameter to pass to the processing routine.
	calRtn	Routine to call for each LMC calorimeter data record in the file. Can be NULL.
	tkrRtn	Routine to call for each LMC tracker data record in the file. Can be NULL.
	acdRtn	Routine to call for each LMC ACD data record in the file. Can be NULL.
	deadRtn	Routine to call for each LMC deadtime data record in the file. Can be NULL.

Return values:

QLMC_SUCCESS

Success

References _QLMC_acdCount::cnt0, _QLMC_tkrCount::cnt0, _QLMC_calCount::cnt0, _QLMC_deadRecord::cntrs, _QLMC_acdRecord::cntrs, _QLMC_tkrRecord::cntrs, _QLMC_calRecord::cntrs, _QLMC_deadCount::dt, _QLMC_acdCount::dt, _QLMC_tkrCount::dt, _QLMC_calCount::dt, _QLMC_tkrRecord::lmsk, _QLMC_calRecord::lmsk, _QLMC_timestamp::secs, _QLMC_deadRecord::tenb, _QLMC_tkrRecord::tenb, _QLMC_calRecord::tenb, _QLMC_acdCount::tile0, _QLMC_deadRecord::ts, _QLMC_acdRecord::ts, _QLMC_tkrRecord::ts, and _QLMC_calRecord::ts.

unsigned QLMC_readSci	(	char *	fName,
		void *	parm,
		QLMC_calCB	calRtn,
		QLMC_tkrCB	tkrRtn,
		QLMC_acdCB	acdRtn,
		QLMC_deadCB	deadRtn
	)

Read the contents of an LMC datagram file.

This routine reads a file of LMC datagrams returned from the LAT, and calls a user-supplied processing routine for each type of data record found.

Parameters:

	fName	The name of the file to be displayed
	parm	User parameter to pass to the processing routine.
	calRtn	Routine to call for each LMC calorimeter data record in the file. Can be NULL.
	tkrRtn	Routine to call for each LMC tracker data record in the file. Can be NULL.
	acdRtn	Routine to call for each LMC ACD data record in the file. Can be NULL.
	deadRtn	Routine to call for each LMC deadtime data record in the file. Can be NULL.

Return values:

QLMC_SUCCESS

Success

References QLMC_procDgm().