GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSE / dev > qseprint / sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QSE » dev » QSE

QSE_printDvr.h File Reference

Interface to the generic event printing routines. More...

#include <LSF/LSF_scan.h>
#include <QSE/QSE_evt.h>
#include <PBI/PTR.h>

Classes

struct  _QSE_printDvrStatsGbl
 Global counts of datagrams, contributions and records. More...
struct  _QSE_printDvrStatsDgm
 Statistics of this datagram, contributions and records. More...
struct  _QSE_printDvrStatsCtb
 Statistics of this contributor, records. More...
struct  _QSE_printDvrStats
 Statistics at the global, datagram, contributor and record level. More...

Typedefs

typedef struct
_QSE_printDvrStatsGbl 		QSE_printDvrStatsGbl
 Typedef for struct QSE_printDvrStatsGbl.
typedef struct
_QSE_printDvrStatsDgm 		QSE_printDvrStatsDgm
 Typedef for struct QSE_printCtxStatsDgm.
typedef struct
_QSE_printDvrStatsCtb 		QSE_printDvrStatsCtb
 Typedef for struct QSE_printDvrStatsCtb.
typedef struct _QSE_printDvrStats QSE_printDvrStats
 Typedef for struct _QSE_printDvrStats.
typedef unsigned int(* QSE_printDvrDgm )(void *context, const LSF_datagram *dgm, void *prm)
 Callback signature for user provided datagram handler.
typedef unsigned int(* QSE_printDvrCtb )(void *context, const LSF_contribution *ctb, void *prm)
 Callback signature for user provided context handler.
typedef unsigned int(* QSE_printDvrRec )(void *context, const LSF_record *rec, void *prm)
 Callback signature for user provided record handler.
typedef enum _QSE_PRINTDVR_FATE_K QSE_PRINTDVR_FATE_K
 Typedef for enum _QSE_PRINTDVR_FATE_K.

Enumerations

enum  _QSE_PRINTDVR_FATE_K {
  QSE_PRINTDVR_FATE_K_CONTINUE = 0,
  QSE_PRINTDVR_FATE_K_STOP = 1
}
 Fate returned by the print driver callback routine to determine whether more events are processed or not.

Functions

unsigned int QSE_printDvrSizeof (void *ctx)
 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 *datgram)
 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

Interface to the generic event printing routines.

Author:
JJRussell - russell@slac.stanford.edu

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

Typedef Documentation

unsigned int int(* QSE_printDvrCtb)(void *context, const LSF_contribution *ctb, void *prm)

Callback signature for user provided context handler.

Return values:
QSE_PRINTDVR_FATE_K_QUIT 
QSE_PRINTDVR_FATE_K_CONTINUE 
Parameters:
context The update context
ctb The datagram contribution
prm User provided parameter, used to dynamically select decoding options.

unsigned int int(* QSE_printDvrDgm)(void *context, const LSF_datagram *dgm, void *prm)

Callback signature for user provided datagram handler.

Return values:
QSE_PRINTDVR_FATE_K_QUIT 
QSE_PRINTDVR_FATE_K_CONTINUE 
Parameters:
context The update context
dgm The datagram
prm User provided parameter

unsigned int(* QSE_printDvrRec)(void *context, const LSF_record *record, void *prm)

Callback signature for user provided record handler.

Return values:
QSE_PRINTDVR_FATE_K_QUIT 
QSE_PRINTDVR_FATE_K_CONTINUE 
Parameters:
context The update context
record The event record to decode
prm User provided parameter, used to dynamically select decoding options.

Function Documentation

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.

Generated on Fri Nov 30 10:34:16 2012 by  doxygen 1.5.8