QSE_evt.h File Reference

Public definition of an event. More...

#include <QSE/QSE_ebf.h>

Classes
struct	_QSE_evtAll
	All the possible representations of an event. More...
struct	_QSE_evt
	Representation of the event. More...
Typedefs
typedef enum _QSE_evtRep	QSE_evtRep
	Typedef for enum _QSE_evtRep.
typedef struct _QSE_evtAll	QSE_evtAll
	Typedef for struct _QSE_evtAll.
typedef struct _QSE_evt	QSE_evt
	Typedef for struct _QSE_evt.
typedef enum _QSE_EVT_OPT_M	QSE_EVT_OPT_M
	Typedef for enum _QSE_EVT_OPT_M.
Enumerations
enum	_QSE_evtRep {   QSE_EVT_REP_K_FAILURE = -1,   QSE_EVT_REP_K_EBF = 0,   QSE_EVT_REP_K_INTERNAL = 1 }
	Enumerates the various formats in which an event can be represented. More...
enum	_QSE_EVT_OPT_M {   QSE_EVT_OPT_M_UPD = (1 << 0),   QSE_EVT_OPT_M_EBF = (1 << 1),   QSE_EVT_OPT_M_INT = (1 << 2),   QSE_EVT_OPT_M_NAT = (1 << 8) }
	Enumerates the decode options. More...
Functions
void	QSE_evtConstruct (QSE_evt *evt)
static __inline const QSE_ebfEvt *	QSE__ebfLocate (const QSE_evt *evt)
	Returns a pointer to the EBF data for this event.

---

Detailed Description

Public definition of an event.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Typedef Documentation

QSE_evt

Typedef for struct _QSE_evt.

Depending on the format the event is transported in, it may be easier to unpack or decode the event into a couple of different formats. This structure contains all the representations (currently envisioned to be 2, a form very near EBF and a random access form) along with a flag word indicating which form the event is being presented in.

QSE_EVT_OPT_M

Typedef for enum _QSE_EVT_OPT_M.

This enumeration is used both when constructing the QSE_evt structure and when calling the decode routines. When used in constructing the QSE_evt, it defines the resources that are available. When used in calling the decode routines, it determines what is filled.

---

Enumeration Type Documentation

enum _QSE_EVT_OPT_M

Enumerates the decode options.

Enumerator:

QSE_EVT_OPT_M_UPD	Only the update information
QSE_EVT_OPT_M_EBF	Support/decode to EBF
QSE_EVT_OPT_M_INT	Support/decode to the internal QSE structures
QSE_EVT_OPT_M_NAT	Decode to which every format is easiest

enum _QSE_evtRep

Enumerates the various formats in which an event can be represented.

Enumerator:

QSE_EVT_REP_K_FAILURE	Event decoding failed
QSE_EVT_REP_K_EBF	Event representation is EBF
QSE_EVT_REP_K_INTERNAL	Event representation is QSE internal

---

Function Documentation

static __inline const QSE_ebfEvt * QSE__ebfLocate

(

const QSE_evt *

evt

)

[static]

Returns a pointer to the EBF data for this event.

Parameters:

evt

The QSE event structure

References _QSE_evtAll::ebf, and _QSE_evt::fmt.