GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> CAB / dev > cmx_asBuilt / rhel4-32
#include <time.h>
Defines | |
#define | CAB_O_EPOCH (0x3a4fc880) |
#define | CAB_L_INDEX (4) |
Typedefs | |
typedef enum _CMX_asBuiltIndex | CMX_asBuiltIndex |
Typedef for enum _CMX_asBuiltIndex. | |
typedef struct _CMX_asBuiltIdentity | CMX_asBuiltIdentity |
Typedef for struct _CMX_asBuiltIdentity. | |
typedef struct _CMX_asBuiltLoad | CMX_asBuiltLoad |
Typedef for struct _CMX_asBuiltLoad. | |
Enumerations | |
enum | _CMX_asBuiltIndex { CAB_K_MODULE = 0, CAB_K_FILE = 1, CAB_K_KEY = 2, CAB_K_SPARE_1 = 3 } |
Indices into the user data storage area of a CMX identity record. More... | |
Functions | |
CMX_asBuiltIdentity * | CMX_asBuiltFind (const char *pkg, const char *con) |
Find a CMX-as-built identity block by package/constituent name. | |
const char * | CMX_asBuiltGetConstit (CMX_asBuiltIdentity *ident) |
Return (a pointer to) the constituent name recorded by CMX-as-built. | |
unsigned int | CMX_asBuiltGetData (CMX_asBuiltIdentity *ident, CMX_asBuiltIndex index, void **value) |
Get data in one of the slots in the user data area. | |
const char * | CMX_asBuiltGetDescrip (CMX_asBuiltIdentity *ident) |
Return (a pointer to) the user supplied descriptive string recorded by CMX-as-built. | |
const char * | CMX_asBuiltGetPackage (CMX_asBuiltIdentity *ident) |
Return (a pointer to) the package name recorded by CMX-as-built. | |
int | CMX_asBuiltGetRevision (CMX_asBuiltIdentity *ident) |
Return the CMX-as-built information revision level. | |
const char * | CMX_asBuiltGetSite (CMX_asBuiltIdentity *ident) |
Return (a pointer to) the build site name recorded by CMX-as-built. | |
const char * | CMX_asBuiltGetTarget (CMX_asBuiltIdentity *ident) |
Return (a pointer to) the build target name recorded by CMX-as-built. | |
time_t | CMX_asBuiltGetTime (CMX_asBuiltIdentity *ident) |
Return the build time-stamp recorded by CMX-as-built. | |
const char * | CMX_asBuiltGetUser (CMX_asBuiltIdentity *ident) |
Return (a pointer to) the builder's userid recorded by CMX-as-built. | |
unsigned int | CMX_asBuiltGetVersion (CMX_asBuiltIdentity *ident, char *version, unsigned short *major, unsigned short *minor, unsigned short *patch) |
Return version information as recorded by CMX-as-built. | |
unsigned int | CMX_asBuiltInsert (CMX_asBuiltIdentity *ident) |
Insert a CMX-as-built identity block into the list. | |
unsigned int | CMX_asBuiltRemove (CMX_asBuiltIdentity *ident) |
Remove a CMX-as-built identity block from the list. | |
CMX_asBuiltIdentity * | CMX_asBuiltScan (CMX_asBuiltIdentity *ident) |
Scan the CMX-as-built identity block list. | |
CMX_asBuiltIdentity * | CMX_asBuiltScanBackward (CMX_asBuiltLoad **load) |
Scan the CMX-as-built load-order block list (backward chronology). | |
CMX_asBuiltIdentity * | CMX_asBuiltScanForward (CMX_asBuiltLoad **load) |
Scan the CMX-as-built load-order block list (forward chronology). | |
unsigned int | CMX_asBuiltSetData (CMX_asBuiltIdentity *ident, CMX_asBuiltIndex index, void *value) |
Set one of the slots in the user data area. | |
unsigned int | CMX_asBuiltValid (CMX_asBuiltIdentity *ident) |
Validate an identity block pointer. |
CVS $Id: CAB_asBuiltPub.h,v 1.2 2011/03/24 02:57:49 apw Exp $
enum _CMX_asBuiltIndex |
Indices into the user data storage area of a CMX identity record.
CMX_asBuilt allows a user to store 4 32-byte quantities into the CMX_as_built information structures. This enumeration is used to define their uses.
CMX_asBuiltIdentity* CMX_asBuiltFind | ( | const char * | pkg, | |
const char * | con | |||
) |
Find a CMX-as-built identity block by package/constituent name.
pkg | (in) Package name | |
con | (in) Constituent name |
NULL | Identity block not found or invalid pkg con name pointers. | |
x | Pointer to identity block |
References _CMX_asBuiltIdentity::constit, _CMX_asBuiltIdentity::next, and _CMX_asBuiltIdentity::package.
const char* CMX_asBuiltGetConstit | ( | CMX_asBuiltIdentity * | ident | ) |
Return (a pointer to) the constituent name recorded by CMX-as-built.
ident | (in) Pointer to identity block |
NULL | Identity block pointer invalid | |
x | Pointer to the constituent name |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::constit.
unsigned int CMX_asBuiltGetData | ( | CMX_asBuiltIdentity * | ident, | |
CMX_asBuiltIndex | index, | |||
void ** | value | |||
) |
Get data in one of the slots in the user data area.
ident | (in) Pointer to identity block (if NULL, most recent) | |
index | (in) Index of location to fetch from | |
value | (in) Value stored in the index |
0 | Success | |
1 | Identity block pointer invalid or unknown auxiliary block revision |
References _CMX_asBuiltIdentity::aux, CMX_asBuiltScanBackward(), CMX_asBuiltValid(), _CMX_asBuiltIdent_1::dat, and _CMX_asBuiltIdentity::rev.
const char* CMX_asBuiltGetDescrip | ( | CMX_asBuiltIdentity * | ident | ) |
Return (a pointer to) the user supplied descriptive string recorded by CMX-as-built.
ident | (in) Pointer to identity block |
NULL | Identity block pointer invalid | |
x | Pointer to the descriptive string |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::desc.
const char* CMX_asBuiltGetPackage | ( | CMX_asBuiltIdentity * | ident | ) |
Return (a pointer to) the package name recorded by CMX-as-built.
ident | (in) Pointer to identity block |
NULL | Identity block pointer invalid | |
x | Pointer to the package name |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::package.
int CMX_asBuiltGetRevision | ( | CMX_asBuiltIdentity * | ident | ) |
Return the CMX-as-built information revision level.
ident | (in) Pointer to identity block |
-1 | Identity block pointer invalid or unknown auxiliary block revision | |
x | Revision level |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::rev.
const char* CMX_asBuiltGetSite | ( | CMX_asBuiltIdentity * | ident | ) |
Return (a pointer to) the build site name recorded by CMX-as-built.
ident | (in) Pointer to identity block |
NULL | Identity block pointer invalid | |
x | Pointer to the build site name |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::site.
const char* CMX_asBuiltGetTarget | ( | CMX_asBuiltIdentity * | ident | ) |
Return (a pointer to) the build target name recorded by CMX-as-built.
ident | (in) Pointer to identity block |
NULL | Identity block pointer invalid | |
x | Pointer to the build target name |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::target.
time_t CMX_asBuiltGetTime | ( | CMX_asBuiltIdentity * | ident | ) |
Return the build time-stamp recorded by CMX-as-built.
ident | (in) Pointer to identity block |
0 | Identity block pointer invalid | |
x | Build time-stamp |
References _CMX_asBuiltIdentity::built, and CMX_asBuiltValid().
const char* CMX_asBuiltGetUser | ( | CMX_asBuiltIdentity * | ident | ) |
Return (a pointer to) the builder's userid recorded by CMX-as-built.
ident | (in) Pointer to identity block |
NULL | Identity block pointer invalid | |
x | Pointer to the builder's userid |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::user.
unsigned int CMX_asBuiltGetVersion | ( | CMX_asBuiltIdentity * | ident, | |
char * | version, | |||
unsigned short * | major, | |||
unsigned short * | minor, | |||
unsigned short * | patch | |||
) |
Return version information as recorded by CMX-as-built.
ident | (in) Pointer to identity block | |
version | (out) Version ('T', 'D', 'P' and 'U') | |
major | (out) Major revision number (only valid when version = 'P') | |
minor | (out) Minor revision number (only valid when version = 'P') | |
patch | (out) Patch revision number (only valid when version = 'P') |
0 | Success | |
x | Identity block pointer invalid or unknown auxiliary block revision |
References _CMX_asBuiltIdentity::aux, CMX_asBuiltValid(), _CMX_asBuiltIdent_0::major, _CMX_asBuiltIdent_0::minor, _CMX_asBuiltIdent_0::patch, and _CMX_asBuiltIdent_0::version.
unsigned int CMX_asBuiltInsert | ( | CMX_asBuiltIdentity * | ident | ) |
Insert a CMX-as-built identity block into the list.
ident | (in) Pointer to identity block |
0 | Success | |
x | Identity block pointer invalid |
References _CMX_asBuiltIdentity::aux, _CMX_asBuiltLoad::bak, CMX_asBuiltRemove(), CMX_asBuiltValid(), _CMX_asBuiltIdentity::constit, _CMX_asBuiltLoad::fwd, _CMX_asBuiltLoad::id, _CMX_asBuiltIdent_1::load, _CMX_asBuiltIdentity::next, _CMX_asBuiltIdentity::package, and _CMX_asBuiltIdentity::rev.
unsigned int CMX_asBuiltRemove | ( | CMX_asBuiltIdentity * | ident | ) |
Remove a CMX-as-built identity block from the list.
ident | (in) Pointer to identity block |
0 | Success | |
x | Identity block pointer invalid or not found on list |
References _CMX_asBuiltIdentity::aux, _CMX_asBuiltLoad::bak, CMX_asBuiltValid(), _CMX_asBuiltLoad::fwd, _CMX_asBuiltLoad::id, _CMX_asBuiltIdent_1::load, _CMX_asBuiltIdentity::next, and _CMX_asBuiltIdentity::rev.
Referenced by CMX_asBuiltInsert().
CMX_asBuiltIdentity* CMX_asBuiltScan | ( | CMX_asBuiltIdentity * | ident | ) |
Scan the CMX-as-built identity block list.
ident | (in/out) Pointer to identity block |
NULL | End of list or identity block pointer invalid | |
x | Pointer to next CMX-as-built identity block |
References CMX_asBuiltValid(), and _CMX_asBuiltIdentity::next.
CMX_asBuiltIdentity* CMX_asBuiltScanBackward | ( | CMX_asBuiltLoad ** | load | ) |
Scan the CMX-as-built load-order block list (backward chronology).
load | (in/out) Pointer to load-order block |
NULL | End of list or load-order block pointer invalid | |
x | Pointer to next CMX-as-built identity block |
References _CMX_asBuiltLoad::bak, and CMX_asBuiltValidLoad().
Referenced by CMX_asBuiltGetData(), and CMX_asBuiltSetData().
CMX_asBuiltIdentity* CMX_asBuiltScanForward | ( | CMX_asBuiltLoad ** | load | ) |
Scan the CMX-as-built load-order block list (forward chronology).
load | (in/out) Pointer to load-order block |
NULL | End of list or load-order block pointer invalid | |
x | Pointer to next CMX-as-built identity block |
References CMX_asBuiltValidLoad(), and _CMX_asBuiltLoad::fwd.
unsigned int CMX_asBuiltSetData | ( | CMX_asBuiltIdentity * | ident, | |
CMX_asBuiltIndex | index, | |||
void * | value | |||
) |
Set one of the slots in the user data area.
ident | (in) Pointer to identity block (if NULL, most recent) | |
index | (in) Index of location to store into | |
value | (in) Value to store in index |
0 | Success | |
x | Identity block pointer invalid or unknown auxiliary block revision |
References _CMX_asBuiltIdentity::aux, CMX_asBuiltScanBackward(), CMX_asBuiltValid(), _CMX_asBuiltIdent_1::dat, and _CMX_asBuiltIdentity::rev.
unsigned int CMX_asBuiltValid | ( | CMX_asBuiltIdentity * | ident | ) |
Validate an identity block pointer.
ident | (in) Pointer to identity block |
0 | Pointer is invalid | |
1 | Pointer is valid |
References _CMX_asBuiltIdentity::frm.
Referenced by CMX_asBuiltGetConstit(), CMX_asBuiltGetData(), CMX_asBuiltGetDescrip(), CMX_asBuiltGetPackage(), CMX_asBuiltGetRevision(), CMX_asBuiltGetSite(), CMX_asBuiltGetTarget(), CMX_asBuiltGetTime(), CMX_asBuiltGetUser(), CMX_asBuiltGetVersion(), CMX_asBuiltInsert(), CMX_asBuiltRemove(), CMX_asBuiltScan(), CMX_asBuiltSetData(), and CMX_asBuiltValidLoad().