GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSEP / V3-5-1 > qsep / rhel5-32
Typedefs | |
typedef enum _QSEP_STATUS_K | QSEP_STATUS_K |
Typedef for QSEP_STATUS_K. | |
Enumerations | |
enum | _QSEP_STATUS_K { QSEP_STATUS_K_ERR = -1, QSEP_STATUS_K_TOO_SMALL = -2, QSEP_STATUS_K_INSRSC = -3, QSEP_STATUS_K_UNKLVL = -7, QSEP_STATUS_K_NOGEM = -8, QSEP_STATUS_K_UNDRUN = -9, QSEP_STATUS_K_OVRRUN = -10, QSEP_STATUS_K_INCLEN = -11, QSEP_STATUS_K_DECOMPRESS = -12, QSEP_STATUS_K_CHECKSUM = -13, QSEP_STATUS_K_LAST_VALID = -13 } |
Enumeration of the status codes. More... | |
Functions | |
QSEP * | QSEP_alloc (int resource_level) |
Allocates and constructs the QSEP handle. | |
int | QSEP_ebfSizeof (void) |
Returns the maximum size, in bytes, of an EBF event. | |
void | QSEP_updateAtDatagram (QSEP *qsep, const LSF_datagram *dgm) |
Updates the run oriented information in the event context using the information from the event datagram. | |
void | QSEP_updateAtContribution (QSEP *qsep, const LSF_contribution *ctb) |
Updates the context based on the contribution. | |
int | QSEP_updateAtRecord (QSEP *qsep, const LSF_record *rec) |
Updates the context based on the record. | |
int | QSEP_expand (QSEP *qsep, const LSF_record *rec, QSE_ebfEvt *ebf, int ebf_size, unsigned int *ret_size) |
Expands the event into EBF format. | |
void | QSEP_destruct (QSEP *qsep) |
Destroys the QSEP handle. | |
const char * | QSEP_statusString (int status) |
Translates a QSEP status code to a string. | |
const QSE_ctx * | QSEP_stdCtxGet (const QSEP *qsep) |
Return a pointer to the standard QSE context block. | |
const QSEP_ctx * | QSEP_appCtxGet (const QSEP *qsep) |
Return a pointer to the public QSEP application specific context block. | |
int | QSEP_sizeof (unsigned int resource_level, void *prm) |
Returns the size, in bytes, of the handle for updating the standard event meta-information. | |
QSEP * | QSEP_construct (QSEP *qsep, unsigned int resource_level, void *prm) |
Construct (initializes) the handle for updating the standard event meta-information. |
CVS $Id: QSEP.h,v 1.9 2011/03/29 18:49:03 russell Exp $
Typedef for QSEP_STATUS_K.
enum _QSEP_STATUS_K |
Enumeration of the status codes.
QSEP* QSEP_alloc | ( | int | resource_level | ) |
Allocates and constructs the QSEP handle.
resource_level | The maximum resource level that is needed |
References QSEP_construct().
Return a pointer to the public QSEP application specific context block.
qsep | The physics event handle |
References _QSEP::atx.
Construct (initializes) the handle for updating the standard event meta-information.
qsep | The handle to initialize, if specified as NULL, one will be allocated | |
resource_level | The maximum resource level. Attempts to expand event with resources needs above this value will return QSEP_STATUS_K_INSRSC, that is INSUFFICIENT RESOURCES. | |
prm | A run-time set parameter used to stylize the configuration |
References _QSEP::atx, _QSEP::ctx, _QSEP::dtx, _QSEP::evt, _QSEP::free, QSEP_ctxConstruct(), qsep_dtx_construct(), qsep_file_ctx_get(), and QSEP_sizeof().
Referenced by QSEP_alloc().
void QSEP_destruct | ( | QSEP * | qsep | ) |
Destroys the QSEP handle.
qsep | The handle to destroy |
References _QSEP::free.
int QSEP_ebfSizeof | ( | void | ) |
Returns the maximum size, in bytes, of an EBF event.
int QSEP_expand | ( | QSEP * | qsep, | |
const LSF_record * | rec, | |||
QSE_ebfEvt * | ebf, | |||
int | ebf_size, | |||
unsigned int * | ret_size | |||
) |
Expands the event into EBF format.
0,Successful | expand | |
<0,Failute,see | the enumeration QSEP_STATUS_K for the reasons |
qsep | The physics event handle | |
rec | The LSF record containing the event | |
ebf | The ebf buffer to expand the event into, this pointer must be 32-bit aligned | |
ebf_size | The size, in bytes, of the buffer | |
ret_size | Returned as the status of the expand |
References _QSEP_dtxEvt::decode, _QSEP::dtx, and _QSEP_dtx::evt.
int QSEP_sizeof | ( | unsigned int | resource_level, | |
void * | prm | |||
) |
Returns the size, in bytes, of the handle for updating the standard event meta-information.
resource_level | The maximum resource level. Attempts to expand event with compression levels that use resources beyond this value will return QSEP_STATUS_K_INSRSC that is INSUFFICIENT RESOURCES. This must be a number between 0 and 15. This parameter plus prm must also be passed to QSEP_construct | |
prm | A run-time set parameter used to stylize the configuration. This parameter plus max_level must also be passed to QSEP_construct. |
References QDFP_ctxSizeof(), QDFP_evtSizeof(), and RND8.
Referenced by QSEP_construct().
const char* QSEP_statusString | ( | int | status | ) |
Translates a QSEP status code to a string.
status | The status code to translate |
References QSEP_STATUS_K_LAST_VALID.
const QSE_ctx* QSEP_stdCtxGet | ( | const QSEP * | qsep | ) |
Return a pointer to the standard QSE context block.
qsep | The physics event handle |
References _QSEP::ctx.
void QSEP_updateAtContribution | ( | QSEP * | qsep, | |
const LSF_contribution * | ctb | |||
) |
Updates the context based on the contribution.
0,if | the contribution is non-record | |
1,if | the contribution is an contribution |
qsep | The physics event handle to update | |
ctb | The contribution |
References _QSEP::ctx, _QSEP::dtx, _QSEP_dtx::evt, QSEP_evt0_update(), QSEP_evt2_update(), QSEP_evt3_update(), and _QSEP_dtxEvt::update.
void QSEP_updateAtDatagram | ( | QSEP * | qsep, | |
const LSF_datagram * | dgm | |||
) |
Updates the run oriented information in the event context using the information from the event datagram.
qsep | The physics event handle | |
dgm | The event datagram |
References _RootUpdateCtx::chg, _QSEP::ctx, _RootUpdateCtx::flags, _RootUpdateCtx::qsep, root_update(), and _RootUpdateCtx::tim.
int QSEP_updateAtRecord | ( | QSEP * | qsep, | |
const LSF_record * | rec | |||
) |
Updates the context based on the record.
Positive | values indicate a successful update to an event record | |
Negative | values indicate an unsuccessful update to an event record | |
0 | indicates that this was not an event record |
qsep | The physics event handle to update | |
rec | The event record |
References _QSEP::ctx, _QSEP::dtx, _QSEP_dtx::evt, and _QSEP_dtxEvt::update.