GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSE / V2-3-0 > qsedgm / linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

QSE_update.h File Reference

Interface to the generic event udpating and handling routines. More...


Classes

struct  _QSE_update
 The dispatch table for updating the event context. More...

Typedefs

typedef int(* QSE_updateSizeof )(void *prm)
 Returns the size, in bytes, of the structure needed for updating all the context associated with the event handling.
typedef void(* QSE_updateConstruct )(void *context, void *prm)
 Constructs (initializes) the structure needed for updating the event handling context.
typedef void(* QSE_updateDestruct )(void *context)
 Deconstructs (initializes) the update context.
typedef void(* QSE_updateAtDatagram )(void *context, const LSF_datagram *datagram)
 Updates the run oriented information in the event context using the information from the event datagram.
typedef void(* QSE_updateAtContribution )(void *context, const LSF_contribution *contribution)
 Updates the contribution context based on the contribution.
typedef int(* QSE_updateAtRecord )(void *context, const LSF_record *record)
 Updates the context based on the record.
typedef void(* QSE_decode )(void *context, const LSF_record *record, void *prm)
 Callback signature for user provided event handler.
typedef struct
_QSE_update 
QSE_update
 Typedef for struct _QSE_update.


Detailed Description

Interface to the generic event udpating and handling routines.

Author:
JJRussell - russell@slac.stanford.edu

   CVS $Id: QSE_update.h,v 1.4 2008/07/16 20:20:08 russell Exp $

Typedef Documentation

void(* QSE_decode)(void *context, const LSF_record *record, void *prm)

Callback signature for user provided event handler.

Parameters:
context The update context
prm User provided parameter, used to dynamically select expansion/decoding options.
record The event record to expand

void(* QSE_updateAtContribution)(void *context, const LSF_contribution *contribution)

Updates the contribution context based on the contribution.

Parameters:
context The QSE update context
contribution The contribution

void(* QSE_updateAtDatagram)(void *context, const LSF_datagram *datagram)

Updates the run oriented information in the event context using the information from the event datagram.

Parameters:
context The update context
datagram The event datagram

int(* QSE_updateAtRecord)(void *context, const LSF_record *record)

Updates the context based on the record.

Returns:
Whether this record contains an event
Parameters:
context The update context
record The record

void *(* QSE_updateConstruct)(void *context, void *prm)

Constructs (initializes) the structure needed for updating the event handling context.

Parameters:
context The context to initialize. If passed in as NULL, then a context will be alllocated.
prm An optional parameter used to tailor the context. In most cases, this will be the same value as passed to the sizeof routine

void(* QSE_updateDestruct)(void *context)

Deconstructs (initializes) the update context.

Parameters:
context The context to initialize
prm An optional parameter used to tailor the context. In most cases, this will be the same value as passed to the sizeof routine

int(* QSE_updateSizeof)(void *prm)

Returns the size, in bytes, of the structure needed for updating all the context associated with the event handling.

Returns:
The size, in bytes, of the structure needed for updating all the context associated with event handling.
Parameters:
prm An optional parameter used to tailor the style of updating In most cases, this will be the same value as passed to the construct routine.


Generated on Thu Sep 2 14:38:42 2010 by  doxygen 1.5.3