QFC_member.h File Reference

Access routines to file cache members. More...

Typedefs
typedef struct _QFC_member	QFC_member
typedef enum _QFC_CAB_BRANCH_K	QFC_CAB_BRANCH_K
	Typedef for enum _QFC_CAB_BRANCH_K.
typedef enum _QFC_MEMBER_TYPE_K	QFC_MEMBER_TYPE_K
	Typedef for enum _QFC_MEMBER_TYPE_K.
Enumerations
enum	_QFC_CAB_BRANCH_K {   QFC_CAB_BRANCH_K_UNDEFINED = -1,   QFC_CAB_BRANCH_K_UNKNOWN = 0,   QFC_CAB_BRANCH_K_PROD = 1,   QFC_CAB_BRANCH_K_DEV = 2,   QFC_CAB_BRANCH_K_TEST = 3 }
	Enumerates the branches. More...
enum	_QFC_MEMBER_TYPE_K {   QFC_MEMBER_TYPE_K_UNDEFINED = -1,   QFC_MEMBER_TYPE_K_UNKNOWN = 0,   QFC_MEMBER_TYPE_K_SO = 1,   QFC_MEMBER_TYPE_K_CDM = 2 }
	Enumerates the various file types. More...
Functions
const char *	QFC_memberNameGet (const QFC_member *member)
	Returns the member's name.
unsigned int	QFC_memberCdmOpen (QFC_member *member)
unsigned int	QFC_memberCabGet (const QFC_member *member)
	The CMX as built information.
QFC_MEMBER_TYPE_K	QFC_memberTypeGet (const QFC_member *member)
	Returns the member's name.
int	QFC_memberVersionGet (const QFC_member *member)
	Returns the member's name.

---

Detailed Description

Access routines to file cache members.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QFC_member.h,v 1.1 2008/06/09 18:16:25 russell Exp $

---

Enumeration Type Documentation

enum _QFC_CAB_BRANCH_K

Enumerates the branches.

Enumerator:

QFC_CAB_BRANCH_K_UNDEFINED	Branch could not be obtained
QFC_CAB_BRANCH_K_UNKNOWN	Branch is not from the known set
QFC_CAB_BRANCH_K_PROD	Branch is from production area
QFC_CAB_BRANCH_K_DEV	Branch is from development area
QFC_CAB_BRANCH_K_TEST	Branch is from test area

enum _QFC_MEMBER_TYPE_K

Enumerates the various file types.

Enumerator:

QFC_MEMBER_TYPE_K_UNDEFINED	Undefined
QFC_MEMBER_TYPE_K_UNKNOWN	Unknown file type
QFC_MEMBER_TYPE_K_SO	Generic shareable object
QFC_MEMBER_TYPE_K_CDM	CDM

---

Function Documentation

unsigned int QFC_memberCabGet

(

const QFC_member *

member

)

The CMX as built information.

Returns:

The CMX as built information, -1 indicates failure

Parameters:

member

The file cache member

References _QFC_member::cab, and _QFC_cab::ui.

const char* QFC_memberNameGet

(

const QFC_member *

member

)

Returns the member's name.

Returns:

Pointer to the member file's name

Parameters:

member

The file cache member

References _QFC_member::name.

QFC_MEMBER_TYPE_K QFC_memberTypeGet

(

const QFC_member *

member

)

Returns the member's name.

Returns:

The version number.

Parameters:

member

The file cache member

References QFC_MEMBER_TYPE_K_UNKNOWN, and _QFC_member::type.

int QFC_memberVersionGet

(

const QFC_member *

member

)

Returns the member's name.

Returns:

The version number.

Parameters:

member

The file cache member

References _QFC_member::version.