GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LSE / V2-1-0 > lsew / linux-gcc
#include <LSE/LFR_key.h>
#include <PBI/Endianness.h>
#include <CMX/CMX_asBuiltPub.h>
#include <CDM/CDM_pubdefs.h>
Classes | |
struct | _LFR_keyGeneric |
The structure of key of a generic key. More... | |
struct | _LFR_keyFmx |
The structure of key of an FMX key. More... | |
struct | _LFR_keyCmx |
The structure of key of type LFR_KEYTYPE_K_CMX. More... | |
struct | _LFR_key |
Union of all key types. More... | |
Typedefs | |
typedef enum _LFR_KEYVAL_K | LFR_KEYVAL_K |
Typedef for enum LFR_KEYVAL_K. | |
typedef struct _LFR_keyGeneric | LFR_keyGeneric |
Typedef for struct _LFR_keyGeneric. | |
typedef struct _LFR_keyFmx | LFR_keyFmx |
Typedef for struct _LFR_keyFmx. | |
typedef struct _LFR_keyCmx | LFR_keyCmx |
Typedef for struct _LFR_keyCmx. | |
typedef union _LFR_key | LFR_key |
Typedef for union _LFR_key. | |
Enumerations | |
enum | _LFR_KEYVAL_K { LFR_KEYVAL_K_UNDEFINED = 0x00ffffff, LFR_KEYVAL_K_FMX_UNDEFINED = LFR_KEYVAL_K_UNDEFINED, LFR_KEYVAL_K_CMX_UNDEFINED = LFR_KEYVAL_K_UNDEFINED, LFR_KEYVAL_K_CMX_UNKNOWN = 0x00fffffe, LFR_KEYVAL_K_CMX_DEV = 0x00fffffd, LFR_KEYVAL_K_CMX_TEST = 0x00fffffc } |
Enumerates special key values. More... | |
Functions | |
static __inline unsigned int | fmxKeyGet (struct _CDM_Database *cdb, unsigned char user) |
Returns the FMX key associated with the file. | |
static __inline unsigned int | cmxKeyGet (struct _CDM_Database *cdb, unsigned char user) |
Returns the CMX key associated with the file. | |
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. |
CVS $Id: LFR_key.c,v 1.4 2011/03/26 17:35:24 russell Exp $
Typedef for struct _LFR_keyFmx.
enum _LFR_KEYVAL_K |
Enumerates special key values.
static __inline unsigned int cmxKeyGet | ( | struct _CDM_Database * | cdb, | |
unsigned char | user | |||
) | [static] |
Returns the CMX key associated with the file.
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 |
References _LFR_key::cmx, _LFR_key::gen, LFR_KEYTYPE_K_CMX, LFR_KEYVAL_K_CMX_DEV, LFR_KEYVAL_K_CMX_TEST, LFR_KEYVAL_K_CMX_UNDEFINED, LFR_KEYVAL_K_CMX_UNKNOWN, and _LFR_key::ui.
Referenced by LFR_keyGet().
static __inline unsigned int fmxKeyGet | ( | struct _CDM_Database * | cdb, | |
unsigned char | user | |||
) | [static] |
Returns the FMX key associated with the file.
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 |
References _LFR_key::fmx, LFR_KEYTYPE_K_FMX, and _LFR_key::ui.
Referenced by LFR_keyGet().
LFR_KEYCMX_BRANCH_K LFR_keyCmxBranchGet | ( | unsigned int | key | ) |
Query function to return the branch type.
key | The key to query |
References _LFR_key::gen, LFR_KEYCMX_BRANCH_K_DEV, LFR_KEYCMX_BRANCH_K_ILLEGAL, LFR_KEYCMX_BRANCH_K_PROD, LFR_KEYCMX_BRANCH_K_TEST, LFR_KEYCMX_BRANCH_K_UNDEFINED, LFR_KEYCMX_BRANCH_K_UNKNOWN, LFR_KEYTYPE_K_CMX, LFR_KEYVAL_K_CMX_DEV, LFR_KEYVAL_K_CMX_TEST, LFR_KEYVAL_K_CMX_UNDEFINED, LFR_KEYVAL_K_CMX_UNKNOWN, and _LFR_key::ui.
unsigned int LFR_keyCmxVersionGet | ( | unsigned int | key | ) |
Query function to return the version.
key | The key to query |
References _LFR_key::gen, and _LFR_key::ui.
unsigned int LFR_keyFmxKeyGet | ( | unsigned int | key | ) |
Query function to return FMX key value.
key | The key to query |
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.
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 |
References cmxKeyGet(), fmxKeyGet(), _LFR_key::gen, LFR_KEYVAL_K_UNDEFINED, and _LFR_key::ui.
Referenced by cal_com_construct(), CDF_acd_construct(), and CDF_tkr_construct().
LFR_KEYTYPE_K LFR_keyTypeGet | ( | unsigned int | key | ) |
Query function to return the encoded key type.
LFR_KEYTYPE_K_FMX | ||
LFR_KEYTYPE_K_CMX |
key | The key to query |
References LFR_KEYTYPE_K_NONE.
unsigned int LFR_keyUserGet | ( | unsigned int | key | ) |
Query function to return the encoded user field.
key | The key to query |