GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QEMP / V1-1-3

Constituent: qemp     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

QEMP.h File Reference

Public interface to the ACD Software Counters. More...

#include "LSF/LSF.h"
#include "EMP/EMP_hdrdefs.h"

Include dependency graph for QEMP.h:

This graph shows which files directly or indirectly include this file:


Typedefs

typedef enum _QEMP_TYPEID QEMP_TYPEID
 type_id used in LSF contributor for QEMP, also returned from QEMP_typeof()
typedef enum _QEMP_STATUS QEMP_STATUS
 Typedef for enum _QSEM_STATUS.

Enumerations

enum  _QEMP_TYPEID {
  QEMP_TYPEID_UNKNOWN = -1,
  QEMP_TYPEID_ASC = 0
}
 Type id used in LSF contributor for uncompressed ASC histogram. More...
enum  _QEMP_STATUS {
  QEMP_STATUS_SUCCESS = 0,
  QEMP_STATUS_DGM_UNKNOWN_TYPEID = -2,
  QEMP_STATUS_DGM_UNKNOWN_VER = -3,
  QEMP_STATUS_CTB_UNKNOWN_VER = -4,
  QEMP_STATUS_CTB_BAD_LEN32 = -5,
  QEMP_STATUS_CTB_UNKNOWN_TYPEID = -6,
  QEMP_STATUS_CTB_WRONG_TYPEID = -7,
  QEMP_STATUS_CTB_INFLATE_FAIL = -8
}
 Enumerates the varios status codes. More...

Functions

unsigned int QEMP_sizeof (QEMP_TYPEID typeid)
 Return the size, in bytes, of the buffer needed to handle data of the specified type.
QEMP_TYPEID QEMP_typeof (const LSF_contribution *ctb)
 Return the type of given contribution.
const char * QEMP_errToStr (QEMP_STATUS status)
 Convert error code to a string.

Detailed Description

Public interface to the ACD Software Counters.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: QEMP.h,v 1.6 2006/10/21 00:29:59 russell Exp $

Enumeration Type Documentation

enum _QEMP_STATUS
 

Enumerates the varios status codes.

Enumerator:
QEMP_STATUS_SUCCESS  All is well
QEMP_STATUS_DGM_UNKNOWN_TYPEID  LSF datagram header has typeid which is not in LSF/LSF_ids.h
QEMP_STATUS_DGM_UNKNOWN_VER  LSF datagram header has an unknown version number
QEMP_STATUS_CTB_UNKNOWN_VER  LSF contributor header has unknown version number
QEMP_STATUS_CTB_BAD_LEN32  LSF contributor has an incorrect length for the packet
QEMP_STATUS_CTB_UNKNOWN_TYPEID  LSF contributor header has typeid which is not in QEMP_TYPEID
QEMP_STATUS_CTB_WRONG_TYPEID  typeid of data does not match the QEMP_xxxGetXxxx
QEMP_STATUS_CTB_INFLATE_FAIL  Decompression step failed

enum _QEMP_TYPEID
 

Type id used in LSF contributor for uncompressed ASC histogram.

Enumerator:
QEMP_TYPEID_UNKNOWN  Contributor type is unknown
QEMP_TYPEID_ASC  Contributor type is an ASC


Function Documentation

const char * QEMP_errToStr QEMP_STATUS  status  ) 
 

Convert error code to a string.

Returns:
string of error code
Parameters:
status status codes QEMP_ERR_Xxxx
----------------------------------------------------------------------

unsigned int QEMP_sizeof QEMP_TYPEID  typeid  ) 
 

Return the size, in bytes, of the buffer needed to handle data of the specified type.

Return values:
The size, in bytes, of the buffer needed to handle data of the specified type.
QEMP_STATUS_CTB_UNKNOWN_TYPEID,if the type id was not recognized

QEMP_TYPEID QEMP_typeof const LSF_contribution *  ctb  ) 
 

Return the type of given contribution.

Return values:
QEMP_TYPEID_ASC 
QEMP_TYPEID_UNKNOWN,if typeid is not recognized
Parameters:
ctb The ontributor to query


Generated on Fri Apr 18 01:16:41 2008 by  doxygen 1.4.4