QSTD_versions.h File Reference

Translates a master version into its sub-versions. More...

Typedefs
typedef struct _QSTD_versionsHandlers	QSTD_versionsHandlers
typedef struct _QSTD_versionsHandler	QSTD_versionsHandler
typedef struct _QSTD_versions	QSTD_versions
typedef enum _QSTD_VERSION_K	QSTD_VERSION_K
	Typedef for enum _QSTD_VERSION_K.
Enumerations
enum	_QSTD_VERSION_K {   QSTD_VERSION_K_SAMPLE = 0,   QSTD_VERSION_K_CONDITIONS = 1 }
	Enumerates the version types. More...
Functions
const QSTD_versionsHandlers *	QSTD_versionsHandlersDefGet (void)
	Retrieves a pointer to statistics handler versions.
const QSTD_versionsHandler *	QSTD_versionsHandlersResolve (const QSTD_versionsHandlers *handlers, unsigned int handler)
	Retrieves a pointer for the subversions for all the versions of the specified handler.
const QSTD_versions *	QSTD_versionsHandlerResolve (const QSTD_versionsHandler *handler, unsigned int version)
	Retrieves a pointer for the subversions for the specified version.
const QSTD_versions *	QSTD_versionsHandlersResolveFull (const QSTD_versionsHandlers *handlers, unsigned int handler, unsigned int version)
	Retrieves a pointer for the versions for the specified handler.
int	QSTD_versionsGet (const QSTD_versions *versions, QSTD_VERSION_K which)
	Retrieves the designated subversion.

---

Detailed Description

Translates a master version into its sub-versions.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QSTD_versions.h,v 1.1 2008/09/18 01:42:44 russell Exp $

The master version serves as the primary key to the various sub-versions. These sub-versions are

• the version of the sample statistics schema
• the version of the conditions, effectively naming the layout of the 32 condition statistics

These two evolve at different times. The former is likely fairly stable, and will change only when the shape of the statistics changes. The latter will change more frequently, changing whenever the bits in the conditions word (the first word of the RSD) are changed. The former is a property of all handlers producting the standard statistics. The latter is a property of each handler.

---

Typedef Documentation

QSTD_VERSION_K

Typedef for enum _QSTD_VERSION_K.

There are two sub-versions associated with a master version

---

Enumeration Type Documentation

enum _QSTD_VERSION_K

Enumerates the version types.

Enumerator:

QSTD_VERSION_K_SAMPLE	Index for the sample version
QSTD_VERSION_K_CONDITIONS	Index for the conditions version

---

Function Documentation

int QSTD_versionsGet	(	const QSTD_versions *	versions,
		QSTD_VERSION_K	which
	)

Retrieves the designated subversion.

Returns:

The designated subversion

Parameters:

	versions	The subversions structure for the handler
	which	Which subversion to get

References _QSTD_versions::sub.

Referenced by QSTD_updateAtDatagram().

const QSTD_versions* QSTD_versionsHandlerResolve	(	const QSTD_versionsHandler *	handler,
		unsigned int	version
	)

Retrieves a pointer for the subversions for the specified version.

Parameters:

	handler	The all the sub-versions of the handler
	version	The version number

References _QSTD_versionsHandler::cnt, and _QSTD_versionsHandler::versions.

Referenced by QSTD_versionsHandlersResolveFull().

const QSTD_versionsHandler* QSTD_versionsHandlersResolve	(	const QSTD_versionsHandlers *	handlers,
		unsigned int	handler
	)

Retrieves a pointer for the subversions 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_versionsHandlers::handler.

Referenced by QSTD_versionsHandlersResolveFull().

const QSTD_versions* QSTD_versionsHandlersResolveFull	(	const QSTD_versionsHandlers *	handlers,
		unsigned int	handler,
		unsigned int	version
	)

Retrieves a pointer for the versions 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_versionsHandlerResolve(), and QSTD_versionsHandlersResolve().

Referenced by QSTD_updateAtDatagram().