GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QLCM / V0-5-2 > qstats_dump / rhel5-32

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QLCM » V0-5-2 » QLCM

QSTATS.h File Reference

Science defs for QSTATS (Stats Monitor controlled by LCM). More...

#include <LSF/LSF.h>
#include <QLCM/QLCBD_stats.h>

Defines

#define QSTATS_PRINT_TIMESTAMP   0x1
 Option mask to print sample timestamp.
#define QSTATS_PRINT_STATS   0x2
 Option mask to print stats.
#define QSTATS_PRINT_LSFHEAD   0x10
 Option mask to print LSF header.

Typedefs

typedef struct _QSTATS_lcb QSTATS_lcb
 Pointer to buff used by QSTATS_lcbXxxx(), size determined by QSTATS_sizeof().
typedef struct _QSTATS_ebm QSTATS_ebm
 Pointer to buff used by QSTATS_ebmXxxx(), size determined by QSTATS_sizeof().

Enumerations

enum  QSTATS_ID {
  QSTATS_ID_UNKNOWN = -1,
  QSTATS_ID_LCB_NOCOMPRESS = 5,
  QSTATS_ID_LCB_COMPRESS = 6,
  QSTATS_ID_EBM_NOCOMPRESS = 7,
  QSTATS_ID_EBM_COMPRESS = 8
}
 type_id used in LSF contributor for QMLCB, also returned from QMLCB_typeof()
enum  QSTATS_STATUS {
  QSTATS_OK = 0,
  QSTATS_ERR_UNKNOWN_DG_TYPEID = -2,
  QSTATS_ERR_UNKNOWN_DG_VER = -3,
  QSTATS_ERR_UNKNOWN_CTB_VER = -4,
  QSTATS_ERR_BAD_CTB_LEN32 = -5,
  QSTATS_ERR_UNKNOWN_CTB_TYPEID = -6,
  QSTATS_ERR_WRONG_TYPEID = -7,
  QSTATS_ERR_INFLATE_FAIL = -8
}
 QMLCB errors returned by QMLCB_xxxExpand.

Functions

LSF_contribution_hdr * QSTATS_swapCtbHdr (LSF_contribution_hdr *ctbPtrOut, const LSF_contribution *ctbPtrIn)
 Routine to pull/swap LSF contributor header from input to output buffer.
unsigned int QSTATS_sizeof ()
 get size of buffer to receive uncompressed/swapped data
QSTATS_ID QSTATS_typeof (const LSF_contribution *ctbPtrIn)
 get type of given contribution
const char * QSTATS_errToStr (QSTATS_STATUS status)
 Convert error code to a string.
QSTATS_STATUS QSTATS_lcbExpand (QSTATS_lcb *lcbPtr, const LSF_contribution *ctbPtrIn)
 Routine to check integrity and swap/uncompress input data into a 2nd buffer.
QSTATS_STATUS QSTATS_ebmExpand (QSTATS_ebm *ebmPtr, const LSF_contribution *ctbPtrIn)
 Routine to check integrity and swap/uncompress input data into a 2nd buffer.
long long QSTATS_lcbGetTimestamp (QSTATS_lcb *lcbPtr)
 Routine to return sample time timestamp from expanded buffer.
QLCBD_stats * QSTATS_lcbGetStats (QSTATS_lcb *lcbPtr)
 Routine to return ptr of QLCBD stat struct from expanded buffer.
long long QSTATS_ebmGetTimestamp (QSTATS_ebm *ebmPtr)
 Routine to return sample time timestamp from expanded buffer.
const unsigned int * QSTATS_ebmGetRecvCTB (QSTATS_ebm *ebmPtr)
 Routine to return array of EBM recv stats.
const unsigned int * QSTATS_ebmGetRecvSIU (QSTATS_ebm *ebmPtr)
 Routine to return array of SIU recv stats.
const unsigned int * QSTATS_ebmGetRecvEPU (QSTATS_ebm *ebmPtr)
 Routine to return array of EPU recv stats.
const unsigned int * QSTATS_ebmGetTransSIU (QSTATS_ebm *ebmPtr)
 Routine to return array of SIU transmit stats.
const unsigned int * QSTATS_ebmGetTransEPU (QSTATS_ebm *ebmPtr)
 Routine to return array of EPU transmit stats.
unsigned int QSTATS_ebmGetTransSSR (QSTATS_ebm *ebmPtr)
 Routine to return SSR transmit stats.
void QSTATS_lcbPrint (QSTATS_lcb *lcbPtr, unsigned int optionMask)
 Print the QSTATS lcb packet given the pointer to the swapped payload.
void QSTATS_ebmPrint (QSTATS_ebm *ebmPtr, unsigned int optionMask)
 Print the QSTATS ebm packet given the pointer to the swapped payload.
unsigned int QSTATS_printDatagram (const LSF_datagram *dgPtr, unsigned int optionMask)
 Print the QSTATS packet given the pointer to the whole LSF datagram.
unsigned int QSTATS_printCtb (const LSF_contribution *ctbPtr, unsigned int optionMask)
 Print the QSTATS packet given the pointer to the LSF contributor.

Detailed Description

Science defs for QSTATS (Stats Monitor controlled by LCM).

Author:
Ed Bacho -- ebacho@slac.stanford.edu This module handles the definitions of structures that are output as science data over the SSR.

Function Documentation

QSTATS_STATUS QSTATS_ebmExpand ( QSTATS_ebm *  ebmPtr,
const LSF_contribution *  ctbPtrIn 
)

Routine to check integrity and swap/uncompress input data into a 2nd buffer.

Parameters:
ebmPtr output buffer of size QSTATS_sizeof(), use as input for QSTATS_ebmGetXxx routines
ctbPtrIn input buffer
Returns:
status codes QSTATS_ERR_Xxxx, 0 if sucessfull
The check routine does integrity checks on the given LSF contributor packet and then decompress/swaps data into the output buffer. THe size of the output buffer is determined by QSTATS_sizeof(). The output buffer can then be used as input with the QSTATS_ebmGetXxxx routines.

References _QSTATS_CompressedBuff_V1::compressedBuff, _QSTATS_CompressedBuff_V1::compressedBuffLen, and QSTATS_MAX_CTB_SIZE.

Referenced by QSTATS_printCtb().

const unsigned int * QSTATS_ebmGetRecvCTB ( QSTATS_ebm *  ebmPtr  ) 

Routine to return array of EBM recv stats.

Parameters:
ebmPtr buff filled in by QSTATS_ebmExpand()
Returns:
int[4] for [GEM,AEM,TEMa,TEMb] ----------------------------------------------------------------------

Referenced by QSTATS_ebmPrint().

const unsigned int * QSTATS_ebmGetRecvEPU ( QSTATS_ebm *  ebmPtr  ) 

Routine to return array of EPU recv stats.

Parameters:
ebmPtr buff filled in by QSTATS_ebmExpand()
Returns:
int[3] for [EPU0,EPU1,EPU2] ----------------------------------------------------------------------

Referenced by QSTATS_ebmPrint().

const unsigned int * QSTATS_ebmGetRecvSIU ( QSTATS_ebm *  ebmPtr  ) 

Routine to return array of SIU recv stats.

Parameters:
ebmPtr buff filled in by QSTATS_ebmExpand()
Returns:
int[3] for [SIU0,SIU1,SIUX] ----------------------------------------------------------------------

Referenced by QSTATS_ebmPrint().

long long QSTATS_ebmGetTimestamp ( QSTATS_ebm *  ebmPtr  ) 

Routine to return sample time timestamp from expanded buffer.

Parameters:
ebmPtr buff filed in by QSTATS_ebmExpand()
Returns:
timestamp of sample time in nanoSec since epoch ----------------------------------------------------------------------

References _QSTATS_ebmBuff_V1::tsNanoSec, and _QSTATS_ebmBuff_V1::tsSec.

Referenced by QSTATS_ebmPrint().

const unsigned int * QSTATS_ebmGetTransEPU ( QSTATS_ebm *  ebmPtr  ) 

Routine to return array of EPU transmit stats.

Parameters:
ebmPtr buff filled in by QSTATS_ebmExpand()
Returns:
int[3] for [EPU0,EPU1,EPU2] ----------------------------------------------------------------------

Referenced by QSTATS_ebmPrint().

const unsigned int * QSTATS_ebmGetTransSIU ( QSTATS_ebm *  ebmPtr  ) 

Routine to return array of SIU transmit stats.

Parameters:
ebmPtr buff filled in by QSTATS_ebmExpand()
Returns:
int[3] for [SIU0,SIU1,SIUX] ----------------------------------------------------------------------

Referenced by QSTATS_ebmPrint().

const unsigned int * QSTATS_ebmGetTransSSR ( QSTATS_ebm *  ebmPtr  ) 

Routine to return SSR transmit stats.

Parameters:
ebmPtr buff filled in by QSTATS_ebmExpand()
Returns:
int for SSR stats ----------------------------------------------------------------------

Referenced by QSTATS_ebmPrint().

void QSTATS_ebmPrint ( QSTATS_ebm *  ebmPtr,
unsigned int  optionMask 
)

Print the QSTATS ebm packet given the pointer to the swapped payload.

Parameters:
ebmPtr Pointer from QSTATS_ebmExpand
optionMask print options
Returns:
none ----------------------------------------------------------------------

References QSTATS_ebmGetRecvCTB(), QSTATS_ebmGetRecvEPU(), QSTATS_ebmGetRecvSIU(), QSTATS_ebmGetTimestamp(), QSTATS_ebmGetTransEPU(), QSTATS_ebmGetTransSIU(), QSTATS_ebmGetTransSSR(), QSTATS_PRINT_STATS, and QSTATS_PRINT_TIMESTAMP.

Referenced by QSTATS_printCtb().

const char * QSTATS_errToStr ( QSTATS_STATUS  status  ) 

Convert error code to a string.

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

Referenced by QSTATS_printCtb().

QSTATS_STATUS QSTATS_lcbExpand ( QSTATS_lcb *  lcbPtr,
const LSF_contribution *  ctbPtrIn 
)

Routine to check integrity and swap/uncompress input data into a 2nd buffer.

Parameters:
lcbPtr output buffer of size QSTATS_sizeof(), use as input for QSTATS_lcbGetXxx routines
ctbPtrIn input buffer
Returns:
status codes QSTATS_ERR_Xxxx, 0 if sucessfull
The check routine does integrity checks on the given LSF contributor packet and then decompress/swaps data into the output buffer. THe size of the output buffer is determined by QSTATS_sizeof(). The output buffer can then be used as input with the QSTATS_lcbGetXxxx routines.

References _QSTATS_CompressedBuff_V1::compressedBuff, _QSTATS_CompressedBuff_V1::compressedBuffLen, and QSTATS_MAX_CTB_SIZE.

Referenced by QSTATS_printCtb().

QLCBD_stats * QSTATS_lcbGetStats ( QSTATS_lcb *  lcbPtr  ) 

Routine to return ptr of QLCBD stat struct from expanded buffer.

Parameters:
lcbPtr buff filed in by QSTATS_lcbExpand()
Returns:
pointer to QLCBD statistics structure ----------------------------------------------------------------------

References _QSTATS_lcbBuff_V1::stats.

Referenced by QSTATS_lcbPrint().

long long QSTATS_lcbGetTimestamp ( QSTATS_lcb *  lcbPtr  ) 

Routine to return sample time timestamp from expanded buffer.

Parameters:
lcbPtr buff filed in by QSTATS_lcbExpand()
Returns:
timestamp of sample time in nanoSec since epoch ----------------------------------------------------------------------

References _QSTATS_lcbBuff_V1::tsNanoSec, and _QSTATS_lcbBuff_V1::tsSec.

Referenced by QSTATS_lcbPrint().

void QSTATS_lcbPrint ( QSTATS_lcb *  lcbPtr,
unsigned int  optionMask 
)

Print the QSTATS lcb packet given the pointer to the swapped payload.

Parameters:
lcbPtr Pointer from QSTATS_lcbExpand
optionMask print options
Returns:
none ----------------------------------------------------------------------

References QSTATS_lcb_show(), QSTATS_lcbGetStats(), QSTATS_lcbGetTimestamp(), QSTATS_PRINT_STATS, and QSTATS_PRINT_TIMESTAMP.

Referenced by QSTATS_printCtb().

unsigned int QSTATS_printCtb ( const LSF_contribution *  ctbPtrIn,
unsigned int  optionMask 
)

Print the QSTATS packet given the pointer to the LSF contributor.

Parameters:
ctbPtrIn Pointer to start of raw LSF contributor (before QEMP_check())
optionMask print options
Returns:
status ----------------------------------------------------------------------

References QSTATS_ebmExpand(), QSTATS_ebmPrint(), QSTATS_errToStr(), QSTATS_lcbExpand(), QSTATS_lcbPrint(), QSTATS_MAX_CTB_SIZE, QSTATS_PRINT_LSFHEAD, QSTATS_swapCtbHdr(), and QSTATS_typeof().

Referenced by QSTATS_printDatagram().

unsigned int QSTATS_printDatagram ( const LSF_datagram *  dgPtr,
unsigned int  optionMask 
)

Print the QSTATS packet given the pointer to the whole LSF datagram.

Parameters:
dgPtr Pointer to start of raw LSF datagram (includes QSTATS_check())
optionMask print options
Returns:
status codes ----------------------------------------------------------------------

References QSTATS_PRINT_LSFHEAD, and QSTATS_printCtb().

unsigned int QSTATS_sizeof (  ) 

get size of buffer to receive uncompressed/swapped data

Returns:
Size of required destination buffer in bytes

References QSTATS_MAX_CTB_SIZE.

LSF_contribution_hdr * QSTATS_swapCtbHdr ( LSF_contribution_hdr *  ctbPtrOut,
const LSF_contribution *  ctbPtrIn 
)

Routine to pull/swap LSF contributor header from input to output buffer.

Parameters:
ctbPtrOut Output buffer to put LSF contributor header in
ctbPtrIn INput buffer with possibly swapped LSF contrib data
Returns:
----------------------------------------------------------------------

Referenced by QSTATS_printCtb(), and QSTATS_typeof().

QSTATS_ID QSTATS_typeof ( const LSF_contribution *  ctbPtr  ) 

get type of given contribution

Parameters:
ctbPtr input buffer
Returns:
type of record --> QEMP_ID_ASC_NOCOMPRESS, or QEMP_ID_ASC_COMPRESS ----------------------------------------------------------------------

References QSTATS_swapCtbHdr().

Referenced by QSTATS_printCtb().

Generated on Wed Mar 30 14:24:42 2011 by  doxygen 1.5.8