EFR_key.h File Reference

Interface to the Event Filter/File Resolution Keys. More...

Typedefs
typedef enum _EFR_KEYTYPE_K	EFR_KEYTYPE_K
	Typedef for struct _EFR_KEYTYPE_K.
typedef enum _EFR_KEYCMX_BRANCH_K	EFR_KEYCMX_BRANCH_K
	Typedef for struct _EFR_KEYCMX_BRANCH_K.
Enumerations
enum	_EFR_KEYTYPE_K {   EFR_KEYTYPE_K_NONE = -1,   EFR_KEYTYPE_K_FMX = 0,   EFR_KEYTYPE_K_CMX = 1 }
	The enumerates the 8 possible key types. More...
enum	_EFR_KEYCMX_BRANCH_K {   EFR_KEYCMX_BRANCH_K_ILLEGAL = -3,   EFR_KEYCMX_BRANCH_K_UNDEFINED = -2,   EFR_KEYCMX_BRANCH_K_UNKNOWN = -1,   EFR_KEYCMX_BRANCH_K_PROD = 0,   EFR_KEYCMX_BRANCH_K_DEV = 1,   EFR_KEYCMX_BRANCH_K_TEST = 2 }
	The enumerates the CMX branch typess. More...
Functions
unsigned int	EFR_keyGet (struct _CDM_Database *cdb, unsigned char user)
EFR_KEYTYPE_K	EFR_keyTypeGet (unsigned int key)
unsigned int	EFR_keyUserGet (unsigned int key)
EFR_KEYCMX_BRANCH_K	EFR_keyCmxBranchGet (unsigned int key)
unsigned int	EFR_keyCmxVersionGet (unsigned int key)
unsigned int	EFR_keyFmxKeyGet (unsigned int key)
static __inline unsigned int	EFR__keyCmxMajorGet (unsigned int cmx_version)
	Extracts the CMX major version number from the specified cmx_version.
static __inline unsigned int	EFR__keyCmxMinorGet (unsigned int cmx_version)
	Extracts the CMX minor version number from the specified cmx_version.
static __inline unsigned int	EFR__keyCmxPatchGet (unsigned int cmx_version)
	Extracts the CMX patch version number from the specified cmx_version.

---

Detailed Description

Interface to the Event Filter/File Resolution Keys.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: EFR_key.h,v 1.1 2007/10/10 23:40:42 russell Exp $

---

Enumeration Type Documentation

enum _EFR_KEYCMX_BRANCH_K

The enumerates the CMX branch typess.

Enumerator:

EFR_KEYCMX_BRANCH_K_ILLEGAL	Attempt to get the branch from a non CMX type key
EFR_KEYCMX_BRANCH_K_UNDEFINED	The original queried file had no CMX as built information with it
EFR_KEYCMX_BRANCH_K_UNKNOWN	The branch returned was not one of PROD, DEV or TEST
EFR_KEYCMX_BRANCH_K_PROD	Production branch
EFR_KEYCMX_BRANCH_K_DEV	Development branch
EFR_KEYCMX_BRANCH_K_TEST	User test branch

enum _EFR_KEYTYPE_K

The enumerates the 8 possible key types.

Enumerator:

EFR_KEYTYPE_K_NONE	NULL key
EFR_KEYTYPE_K_FMX	FMX key
EFR_KEYTYPE_K_CMX	CMX tag style key

---

Function Documentation

static __inline unsigned int EFR__keyCmxMajorGet

(

unsigned int

cmx_version

)

[static]

Extracts the CMX major version number from the specified cmx_version.

Parameters:

cmx_version

The packed cmx version value to use. This is generally gotten from the return value of EFR_keyCmxVersionGet.

static __inline unsigned int EFR__keyCmxMinorGet

(

unsigned int

cmx_version

)

[static]

Extracts the CMX minor version number from the specified cmx_version.

Parameters:

cmx_version

The packed cmx version value to use. This is generally gotten from the return value of EFR_keyCmxVersionGet.

static __inline unsigned int EFR__keyCmxPatchGet

(

unsigned int

cmx_version

)

[static]

Extracts the CMX patch version number from the specified cmx_version.

Parameters:

cmx_version

The packed cmx version value to use. This is generally gotten from the return value of EFR_keyCmxVersionGet.