QSE_printDvr.c File Reference

Dumps events. More...

#include <QSE/QSE_printDvr.h>
#include <QSE/QSE_update.h>
#include <QSE/QSE_evt.h>
#include <LSE/LSE_stdCtb.h>
#include <LSE/LSE_stdCtbPrint.h>
#include <EDS/EBF_dir.h>
#include <LSF/LSF.h>
#include <LSF/LSF_scan.h>
#include <LSF/LSF_print.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

Classes
struct	_QSE_printDvr
	Print context. More...
Typedefs
typedef struct _QSE_printDvr	QSE_printDvr
	struct _QSE_printDvr
Functions
static LSF_scanRecordHandler	evt_contribution_print (QSE_printDvr *dvr, const LSF_contribution *ctb)
	Prints the header of the specified contribution.
static unsigned int	evt_record_print (QSE_printDvr *dvr, const LSF_record *rec)
	Prints the header of the specified contribution.
unsigned int	QSE_printDvrSizeof (void *prm)
	Returns the size, in bytes of a QSE_printDvr structure.
QSE_printDvr *	QSE_printDvrConstruct (QSE_printDvr *dvr, PTR_as_uint options, const QSE_update *upd_tbl, void *upd_prm, QSE_printDvrDgm dgm_rtn, QSE_printDvrCtb ctb_rtn, QSE_printDvrRec rec_rtn, void *usr_prm)
	Constructs/initializes the print context control block.
LSF_scanContributionHandler	QSE_printDvrDatagram (QSE_printDvr *dvr, const LSF_datagram *dgm)
	Prints the header of the specified datagram.
void	QSE_printDvrDestruct (QSE_printDvr *dvr)
	Frees any resources garnered during the contruction phase.
const QSE_printDvrStats *	QSE_printDvrStatsLocate (QSE_printDvr *dvr)
	Retrieves a pointer to the statistics.
void	QSE_printDvrStatsClear (QSE_printDvr *dvr)
	Clears the print driver statistics.

---

Detailed Description

Dumps events.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QSE_printDvr.c,v 1.6 2011/03/27 01:45:45 russell Exp $

---

Function Documentation

LSF_scanRecordHandler evt_contribution_print	(	QSE_printDvr *	dvr,
		const LSF_contribution *	ctb
	)			[static]

Prints the header of the specified contribution.

Return values:

0,indicating

to continue the scan

Parameters:

	dvr	Print context parameter
	ctb	The contribution to print

References _QSE_printDvrStats::ctb, _QSE_printDvr::ctb_rtn, _QSE_printDvrStatsDgm::ctbs, _QSE_printDvrStatsGbl::ctbs, _QSE_printDvrStats::dgm, evt_record_print(), _QSE_printDvrStats::gbl, _QSE_printDvrStatsCtb::recs, _QSE_printDvr::stats, _QSE_printDvr::upd_prm, _QSE_printDvr::upd_tbl, _QSE_update::updateAtContribution, and _QSE_printDvr::usr_prm.

Referenced by QSE_printDvrDatagram().

static unsigned int evt_record_print	(	QSE_printDvr *	dvr,
		const LSF_record *	rec
	)			[static]

Prints the header of the specified contribution.

Return values:

0,indicating

to continue the scan

Parameters:

	dvr	Print context parameter
	rec	The record to print

References _QSE_printDvrStats::ctb, _QSE_printDvrStats::dgm, _QSE_printDvrStats::gbl, _QSE_printDvr::rec_rtn, _QSE_printDvrStatsDgm::recs, _QSE_printDvrStatsGbl::recs, _QSE_printDvrStatsCtb::recs, _QSE_printDvr::stats, _QSE_printDvr::upd_prm, _QSE_printDvr::upd_tbl, _QSE_update::updateAtRecord, and _QSE_printDvr::usr_prm.

Referenced by evt_contribution_print().

QSE_printDvr * QSE_printDvrConstruct	(	QSE_printDvr *	dvr,
		PTR_as_uint	options,
		const QSE_update *	upd_tbl,
		void *	upd_prm,
		QSE_printDvrDgm	dgm_rtn,
		QSE_printDvrCtb	ctb_rtn,
		QSE_printDvrRec	rec_rtn,
		void *	usr_prm
	)

Constructs/initializes the print context control block.

Returns:

Pointer to the construct print driver context

Parameters:

	dvr	The print context to construct/initialize, if this is NULL, a print context will be allocated using malloc.
	options	An options word, currently unused, specify as 0
	upd_tbl	The table of event updating routines
	upd_prm	The update routines' parameter
	dgm_rtn	Routine to handle datagrams
	ctb_rtn	Routine to handle contributions
	rec_rtn	Routine to handle the records
	usr_prm	Parameter passed to the datagram, contribution and record handling routines.

References _QSE_printDvr::ctb_rtn, _QSE_printDvr::dgm_rtn, _QSE_printDvr::free, _QSE_printDvr::options, _QSE_printDvr::rec_rtn, _QSE_printDvr::stats, _QSE_printDvr::upd_prm, _QSE_printDvr::upd_tbl, and _QSE_printDvr::usr_prm.

LSF_scanContributionHandler QSE_printDvrDatagram	(	QSE_printDvr *	dvr,
		const LSF_datagram *	dgm
	)

Prints the header of the specified datagram.

Return values:

The

contribution level handler (routine + parameter)

Parameters:

	dvr	Print context parameter
	dgm	The datagram to print

References _QSE_printDvrStatsDgm::ctbs, _QSE_printDvrStats::dgm, _QSE_printDvr::dgm_rtn, _QSE_printDvrStatsGbl::dgms, evt_contribution_print(), _QSE_printDvrStats::gbl, _QSE_printDvrStatsDgm::recs, _QSE_printDvr::stats, _QSE_printDvr::upd_prm, _QSE_printDvr::upd_tbl, _QSE_update::updateAtDatagram, and _QSE_printDvr::usr_prm.

void QSE_printDvrDestruct

(

QSE_printDvr *

dvr

)

Frees any resources garnered during the contruction phase.

Parameters:

dvr

The print context to destruct

References _QSE_printDvr::free.

unsigned int QSE_printDvrSizeof

(

void *

prm

)

Returns the size, in bytes of a QSE_printDvr structure.

Returns:

The size, in bytes of a QSE_printDvr structure

Parameters:

prm

Arbitrary user parameter, unused.

void QSE_printDvrStatsClear

(

QSE_printDvr *

dvr

)

Clears the print driver statistics.

Parameters:

dvr

Print context parameter

References _QSE_printDvr::stats.

const QSE_printDvrStats * QSE_printDvrStatsLocate

(

QSE_printDvr *

dvr

)

Retrieves a pointer to the statistics.

Returns:

A readonly pointer to the statistics

Parameters:

dvr

Print context parameter

References _QSE_printDvr::stats.