QSTD_labels.c File Reference

Interface to get the statistics labels. More...

#include <QSSP/QSTD_labels.h>

Classes
struct	_QSTD_labels
	Contains the statistics specific labels. More...
struct	_QSTD_labelsVersions
	The labels for each version of a given handler. More...
struct	_QSTD_labelsHandlers
	Aggregates the QSTD_labels for all the handlers. More...
Typedefs
typedef struct _QSTD_labels	QSTD_labels
typedef struct _QSTD_labelsVersions	QSTD_labelsVersions
	Typedef for struct _QSTD_labelsVersions.
typedef struct _QSTD_labelsHandlers	QSTD_labelsHandlers
	Typedef for struct _QSTD_labelsHandlers.
Functions
const QSTD_labelsHandlers *	QSTD_labelsHandlersDefGet (void)
	Retrieves a pointer to statistics handler labels.
__inline const QSTD_labelsVersions *	QSTD_labelsHandlersResolve (const QSTD_labelsHandlers *handlers, unsigned int handler)
	Retrieves a pointer for the labels for all the versions of the specified handler.
__inline const QSTD_labels *	QSTD_labelsVersionsResolve (const QSTD_labelsVersions *versions, unsigned int version)
	Retrieves a pointer for the labels for the specified version.
const QSTD_labels *	QSTD_labelsHandlersResolveFull (const QSTD_labelsHandlers *handlers, unsigned int handler, unsigned int version)
	Retrieves a pointer for the labels for the specified handler.
const char *	QSTD_labelsHandlerGet (const QSTD_labels *labels)
	Retrieves a pointer to title string (the handler name).
const char *	QSTD_labelsConditionGet (const QSTD_labels *labels, unsigned int conditionId)
	Retrieves a pointer to condition string (the condition's name).
Variables
static const char	UnkConditions [32][16]
static const QSTD_labels	UnkLabelsV0
static const QSTD_labels *	UnkLabelsArray [1]
static const QSTD_labelsVersions	UnkVersions

---

Detailed Description

Interface to get the statistics labels.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QSTD_labels.c,v 1.3 2011/03/29 00:14:57 russell Exp $

---

Function Documentation

const char * QSTD_labelsConditionGet	(	const QSTD_labels *	labels,
		unsigned int	conditionId
	)

Retrieves a pointer to condition string (the condition's name).

Parameters:

	labels	The label structure for the handler
	conditionId	The condition identify [0,31]

References _QSTD_labels::conditions.

const char * QSTD_labelsHandlerGet

(

const QSTD_labels *

labels

)

Retrieves a pointer to title string (the handler name).

Parameters:

labels

The label structure for the handler

References _QSTD_labels::handler.

const QSTD_labelsVersions * QSTD_labelsHandlersResolve	(	const QSTD_labelsHandlers *	handlers,
		unsigned int	handler
	)

Retrieves a pointer for the labels for all the versions of the specified handler.

Parameters:

	handlers	The labels for all the handlers
	handler	The handler's identifier (e.g. EH_ID_K_GAMMA, etc)

References _QSTD_labelsHandlers::versions.

Referenced by QSTD_labelsHandlersResolveFull().

const QSTD_labels * QSTD_labelsHandlersResolveFull	(	const QSTD_labelsHandlers *	handlers,
		unsigned int	handler,
		unsigned int	version
	)

Retrieves a pointer for the labels for the specified handler.

Parameters:

	handlers	The labels for all the handlers
	handler	The handler's identifier (e.g. EH_ID_K_GAMMA, etc)
	version	The version number

References QSTD_labelsHandlersResolve(), and QSTD_labelsVersionsResolve().

Referenced by QSTD_updateAtDatagram().

const QSTD_labels * QSTD_labelsVersionsResolve	(	const QSTD_labelsVersions *	versions,
		unsigned int	version
	)

Retrieves a pointer for the labels for the specified version.

Parameters:

	versions	The labels for all versions of the handler
	version	The version number

References _QSTD_labelsVersions::cnt, and _QSTD_labelsVersions::labels.

Referenced by QSTD_labelsHandlersResolveFull().

---

Variable Documentation

const QSTD_labels* UnkLabelsArray[1] [static]

Initial value:

{
    &UnkLabelsV0
}

const QSTD_labels UnkLabelsV0 [static]

Initial value:

{
    "Unknown        ",        
    &UnkConditions
}

const QSTD_labelsVersions UnkVersions [static]

Initial value:

{
    1,
    UnkLabelsArray
}