QSEC.h File Reference

Interface to the calibration event context updating routines. More...

#include <QSEC/QSEC_ctx.h>
#include <EDS/EBF_gem.h>

Typedefs
typedef enum _QSEC_STATUS_K	QSEC_STATUS_K
	Enumeration of the status codes.
Enumerations
enum	_QSEC_STATUS_K {   QSEC_STATUS_K_ERR = -1,   QSEC_STATUS_K_TOO_SMALL = -2,   QSEC_STATUS_K_DECODE = -3,   QSEC_STATUS_K_NOGEM = -8,   QSEC_STATUS_K_OVRRUN = -9,   QSEC_STATUS_K_UNDRUN = -10,   QSEC_STATUS_K_INCLEN = -11 }
	Enumeration of the status codes. More...
Functions
QSEC *	QSEC_alloc (void)
void	QSEC_updateAtDatagram (void *qsec, const LSF_datagram *dgm)
void	QSEC_updateAtContribution (void *qsec, const LSF_contribution *ctb)
int	QSEC_updateAtRecord (void *qsec, const LSF_record *rec)
int	QSEC_expand (QSEC *qsec, const LSF_record *rec, QSE_ebfEvt *ebf, int ebf_size, int *ret_size)
void	QSEC_destruct (QSEC *qsec)
const QSE_ctx *	QSEC_stdCtxGet (const QSEC *qsec)
const QSEC_ctx *	QSEC_appCtxGet (const QSEC *qsec)
const EBF_gem *	QSEC_gemGet (const QSEC *qsec)
unsigned int	QSEC_sizeof (void *prm)
QSEC *	QSEC_construct (QSEC *qsec, void *prm)
void	QSEC_reportExpand (const QSEC *qsec, FILE *fp, unsigned int optns)
void	QSEC_reportExp (const QSEC *qsec, FILE *fp)

---

Detailed Description

Interface to the calibration event context updating routines.

Author:

James Swain & Owen Saxton

Id

QSEC.h,v 1.8 2011/03/28 19:22:03 saxton Exp

---

Typedef Documentation

typedef enum _QSEC_STATUS_K QSEC_STATUS_K

Enumeration of the status codes.

The errors breakdown into roughly two categories

1. User errors
2. Internal errors

User Errors

Currently there is one user errors.

1. The user specified an output buffer that was too small to accommodate the event.

Internal Errors

The candidates for causing these errors are

1. Internal error on the encoding side, i.e. the software that formatted and wrote the event out has an error.
2. Internal error on the decoding side, i.e. the software that is decoding the event has an error.
3. The input data was corrupted (for example a memory overwrite) after it was read in.

---

Enumeration Type Documentation

enum _QSEC_STATUS_K

Enumeration of the status codes.

The errors breakdown into roughly two categories

1. User errors
2. Internal errors

User Errors

Currently there is one user errors.

1. The user specified an output buffer that was too small to accommodate the event.

Internal Errors

The candidates for causing these errors are

1. Internal error on the encoding side, i.e. the software that formatted and wrote the event out has an error.
2. Internal error on the decoding side, i.e. the software that is decoding the event has an error.
3. The input data was corrupted (for example a memory overwrite) after it was read in.

Enumerator:

QSEC_STATUS_K_ERR	Generic failure
QSEC_STATUS_K_TOO_SMALL	The user provided buffer is too small to accommodate the expanded event.
QSEC_STATUS_K_DECODE	An error occurred during decoding, most likely because the version number of the encoded data was larger than the current version.
QSEC_STATUS_K_NOGEM	The GEM contribution could not be located in the input data. Without the GEM contribution, the extended counter information cannot be updated. This is likely caused by an internal error. It is possible that there is a bug in the encoding/decoding of the data or that the input data was somehow corrupted.
QSEC_STATUS_K_OVRRUN	There was data still in the input was still left after expanding thought it had completed. This is likely caused by an internal error. It is possible that there is a bug in the encoding/decoding of the data or that the input data was somehow corrupted.
QSEC_STATUS_K_UNDRUN	The input data was exhausted before the expansion thought it had completed. This is likely caused by an internal error. It is possible that there is a bug in the encoding/decoding of the data or that the input data was somehow corrupted.
QSEC_STATUS_K_INCLEN	An inconsistency in the calculation of the number of bytes to in the output stream and actual number. This is purely an internal error in the expansion/unpacking routines