GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> EFC / V4-5-5 > gefc / sun-gcc
#include <EFC/EFR_key.h>
#include <PBI/Endianness.h>
#include <CAB/CAB_asBuiltPub.h>
#include <CDM/CDM_pubdefs.h>
Classes | |
struct | _EFR_keyGeneric |
The structure of key of a generic key. More... | |
struct | _EFR_keyFmx |
The structure of key of an FMX key. More... | |
struct | _EFR_keyCmx |
The structure of key of type EFR_KEYTYPE_K_CMX. More... | |
struct | _EFR_key |
Union of all key types. More... | |
Typedefs | |
typedef enum _EFR_KEYVAL_K | EFR_KEYVAL_K |
Typedef for enum EFR_KEYVAL_K. | |
typedef struct _EFR_keyGeneric | EFR_keyGeneric |
Typedef for struct _EFR_keyGeneric. | |
typedef struct _EFR_keyFmx | EFR_keyFmx |
Typedef for struct _EFR_keyFmx. | |
typedef struct _EFR_keyCmx | EFR_keyCmx |
Typedef for struct _EFR_keyCmx. | |
typedef union _EFR_key | EFR_key |
Typedef for union _EFR_key. | |
Enumerations | |
enum | _EFR_KEYVAL_K { EFR_KEYVAL_K_UNDEFINED = 0x00ffffff, EFR_KEYVAL_K_FMX_UNDEFINED = EFR_KEYVAL_K_UNDEFINED, EFR_KEYVAL_K_CMX_UNDEFINED = EFR_KEYVAL_K_UNDEFINED, EFR_KEYVAL_K_CMX_UNKNOWN = 0x00fffffe, EFR_KEYVAL_K_CMX_DEV = 0x00fffffd, EFR_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 | EFR_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. | |
EFR_KEYTYPE_K | EFR_keyTypeGet (unsigned int key) |
Query function to return the encoded key type. | |
unsigned int | EFR_keyUserGet (unsigned int key) |
Query function to return the encoded user field. | |
EFR_KEYCMX_BRANCH_K | EFR_keyCmxBranchGet (unsigned int key) |
Query function to return the branch type. | |
unsigned int | EFR_keyCmxVersionGet (unsigned int key) |
Query function to return the version. | |
unsigned int | EFR_keyFmxKeyGet (unsigned int key) |
Query function to return FMX key value. |
CVS $Id: EFR_key.c,v 1.3 2011/04/06 00:32:37 russell Exp $
Typedef for struct _EFR_keyFmx.
enum _EFR_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 _EFR_key::cmx, EFR_KEYTYPE_K_CMX, EFR_KEYVAL_K_CMX_DEV, EFR_KEYVAL_K_CMX_TEST, EFR_KEYVAL_K_CMX_UNDEFINED, EFR_KEYVAL_K_CMX_UNKNOWN, _EFR_key::gen, and _EFR_key::ui.
Referenced by EFR_keyGet().
EFR_KEYCMX_BRANCH_K EFR_keyCmxBranchGet | ( | unsigned int | key | ) |
Query function to return the branch type.
key | The key to query |
References EFR_KEYCMX_BRANCH_K_DEV, EFR_KEYCMX_BRANCH_K_ILLEGAL, EFR_KEYCMX_BRANCH_K_PROD, EFR_KEYCMX_BRANCH_K_TEST, EFR_KEYCMX_BRANCH_K_UNDEFINED, EFR_KEYCMX_BRANCH_K_UNKNOWN, EFR_KEYTYPE_K_CMX, EFR_KEYVAL_K_CMX_DEV, EFR_KEYVAL_K_CMX_TEST, EFR_KEYVAL_K_CMX_UNDEFINED, EFR_KEYVAL_K_CMX_UNKNOWN, _EFR_key::gen, and _EFR_key::ui.
unsigned int EFR_keyCmxVersionGet | ( | unsigned int | key | ) |
Query function to return the version.
key | The key to query |
References _EFR_key::gen, and _EFR_key::ui.
unsigned int EFR_keyFmxKeyGet | ( | unsigned int | key | ) |
Query function to return FMX key value.
key | The key to query |
References _EFR_key::fmx, and _EFR_key::ui.
unsigned int EFR_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(), EFR_KEYVAL_K_UNDEFINED, fmxKeyGet(), _EFR_key::gen, and _EFR_key::ui.
Referenced by construct_efc().
EFR_KEYTYPE_K EFR_keyTypeGet | ( | unsigned int | key | ) |
Query function to return the encoded key type.
EFR_KEYTYPE_K_FMX | ||
EFR_KEYTYPE_K_CMX |
key | The key to query |
References EFR_KEYTYPE_K_NONE, _EFR_key::gen, and _EFR_key::ui.
unsigned int EFR_keyUserGet | ( | unsigned int | key | ) |
Query function to return the encoded user field.
key | The key to query |
References _EFR_key::gen, and _EFR_key::ui.
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 EFR_KEYTYPE_K_FMX, _EFR_key::fmx, and _EFR_key::ui.
Referenced by EFR_keyGet().