---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LSE / V1-3-5

Constituent: lser     Tag: mv2304

---

         

---

LFR_key.h File Reference

Interface to the LAT File Resolution Keys. More...

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

Typedefs
typedef enum _LFR_KEYTYPE_K	LFR_KEYTYPE_K
	Typedef for struct _LFR_KEYTYPE_K.
typedef enum _LFR_KEYCMX_BRANCH_K	LFR_KEYCMX_BRANCH_K
	Typedef for struct _LFR_KEYCMX_BRANCH_K.
Enumerations
enum	_LFR_KEYTYPE_K {   LFR_KEYTYPE_K_NONE = -1,   LFR_KEYTYPE_K_FMX = 0,   LFR_KEYTYPE_K_CMX = 1 }
	The enumerates the 8 possible key types. More...
enum	_LFR_KEYCMX_BRANCH_K {   LFR_KEYCMX_BRANCH_K_ILLEGAL = -3,   LFR_KEYCMX_BRANCH_K_UNDEFINED = -2,   LFR_KEYCMX_BRANCH_K_UNKNOWN = -1,   LFR_KEYCMX_BRANCH_K_PROD = 0,   LFR_KEYCMX_BRANCH_K_DEV = 1,   LFR_KEYCMX_BRANCH_K_TEST = 2 }
	The enumerates the CMX branch typess. More...
Functions
unsigned int	LFR_keyGet (struct _CDM_Database *cdb, unsigned char user)
	Returns the key associated with the file. This may be either an FMX or CMX style key, with the FMX key, if it exists, given the perference.
LFR_KEYTYPE_K	LFR_keyTypeGet (unsigned int key)
	Query function to return the encoded key type.
unsigned int	LFR_keyUserGet (unsigned int key)
	Query function to return the encoded user field.
LFR_KEYCMX_BRANCH_K	LFR_keyCmxBranchGet (unsigned int key)
	Query function to return the branch type.
unsigned int	LFR_keyCmxVersionGet (unsigned int key)
	Query function to return the version.
unsigned int	LFR_keyFmxKeyGet (unsigned int key)
	Query function to return FMX key value.
static __inline unsigned int	LFR__keyCmxMajorGet (unsigned int cmx_version)
	Extracts the CMX major version number from the specified cmx_version.
static __inline unsigned int	LFR__keyCmxMinorGet (unsigned int cmx_version)
	Extracts the CMX minor version number from the specified cmx_version.
static __inline unsigned int	LFR__keyCmxPatchGet (unsigned int cmx_version)
	Extracts the CMX patch version number from the specified cmx_version.

---

Detailed Description

Interface to the LAT File Resolution Keys.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: LFR_key.h,v 1.1 2006/11/01 21:57:27 russell Exp $

---

Enumeration Type Documentation

enum _LFR_KEYCMX_BRANCH_K

The enumerates the CMX branch typess. Enumerator: LFR_KEYCMX_BRANCH_K_ILLEGAL  Attempt to get the branch from a non CMX type key LFR_KEYCMX_BRANCH_K_UNDEFINED  The original queried file had no CMX as built information with it LFR_KEYCMX_BRANCH_K_UNKNOWN  The branch returned was not one of PROD, DEV or TEST LFR_KEYCMX_BRANCH_K_PROD  Production branch LFR_KEYCMX_BRANCH_K_DEV  Development branch LFR_KEYCMX_BRANCH_K_TEST  User test branch

enum _LFR_KEYTYPE_K

The enumerates the 8 possible key types. Enumerator: LFR_KEYTYPE_K_NONE  NULL key LFR_KEYTYPE_K_FMX  FMX key LFR_KEYTYPE_K_CMX  CMX tag style key

---

Function Documentation

static __inline unsigned int LFR__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 LFR_keyCmxVersionGet.

static __inline unsigned int LFR__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 LFR_keyCmxVersionGet.

static __inline unsigned int LFR__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 LFR_keyCmxVersionGet.

LFR_KEYCMX_BRANCH_K LFR_keyCmxBranchGet (  unsigned int  key  )

Query function to return the branch type. Returns: One of the enumeratin LFR_KEYCMX_BRANCH_K Parameters: key  The key to query

unsigned int LFR_keyCmxVersionGet (  unsigned int  key  )

Query function to return the version. Returns: The packed version number Parameters: key  The key to query Warning: This function is valid if and only this is a CMX key from the production branch. It is the user responsibility to verify this before calling this function.

unsigned int LFR_keyFmxKeyGet (  unsigned int  key  )

Query function to return FMX key value. Returns: The FMX key value Parameters: key  The key to query Warning: This function is valid if and only this is a FMX key. It is the user responsibility to verify this before calling this function.

unsigned int LFR_keyGet (  struct _CDM_Database *  cdb, unsigned char  user )

Returns the key associated with the file. This may be either an FMX or CMX style key, with the FMX key, if it exists, given the perference. Returns: The key Parameters: cdb  The CMX database to query for the key user  A small integer (typically less than 31, that will be associated with the key. This is meant to help resolves files of similar types that may reside in different directories

LFR_KEYTYPE_K LFR_keyTypeGet (  unsigned int  key  )

Query function to return the encoded key type. Return values: LFR_KEYTYPE_K_FMX  LFR_KEYTYPE_K_CMX  Parameters: key  The key to query

unsigned int LFR_keyUserGet (  unsigned int  key  )

Query function to return the encoded user field. Returns: The user user field Parameters: key  The key to query Warning: This function assumes the user has checked the check type for being valid, i.e. not LFR_KEYTYPE_K_NONE.

---