QFR_cdm.h File Reference

Interface to convenience routines to load CDM modules. More...

Classes
struct	_QFR_cdmTemplate
	Provides the template structure for file name resolution. More...
Typedefs
typedef struct _QFR_fileCtx	QFR_fileCtx
	Typedef for struct _QFR_fileCtx.
typedef unsigned int(*	QFR_cdmConstructor )(void *constants, const void *schema, const char *name)
	Constructor for a set of constants.
typedef struct _QFR_cdmTemplate	QFR_cdmTemplate
	Typedef for struct _QFR_cdmTemplate.
Functions
struct _CDM_Database *	QFR_cdmDbLoad (const QFR_cdmTemplate *template, QFR_fileCtx *qfr, unsigned int key, char *name, unsigned int name_size)
	Utility routine to construct a fully resolve file name to a database, then load it.
unsigned int	QFR_cdmConstantsLoad (const QFR_cdmTemplate *template, QFR_fileCtx *qfr, unsigned int key, QFR_cdmConstructor ctor, void *ctor_prms, char *name, unsigned int name_size)
	Utility routine to construct a fully resolve file name to a database, then load it.

---

Detailed Description

Interface to convenience routines to load CDM modules.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QFR_cdm.h,v 1.1.1.1 2008/04/02 01:05:53 russell Exp $

---

Typedef Documentation

unsigned int(* QFR_cdmConstructor)(void *constants, const void *schema, const char *name)

Constructor for a set of constants.

Returns:

The checksum

Parameters:

	constants	The constants structure to fill
	schema	The database schema, This may be NULL if the file name could not be resolved
	name	The name of the CDM database

---

Function Documentation

unsigned int QFR_cdmConstantsLoad	(	const QFR_cdmTemplate *	template,
		QFR_fileCtx *	qfr,
		unsigned int	key,
		QFR_cdmConstructor	ctor,
		void *	ctor_prm,
		char *	name,
		unsigned int	name_size
	)

Utility routine to construct a fully resolve file name to a database, then load it.

Returns:

On success, the checksum 0 on failure

Parameters:

	template	The template containing the list of directory paths and the file name.
	qfr	The file resolution context.
	key	The key used to find the specific file
	ctor	The construct, this will be called back with the found database and the constants
	ctor_prm	Arbibrary parameter passed to the ctor routine
	name	Name buffer, if non-NULL, filled in with the resolved file name. The name is NUL-terminated
	name_size	The size, in byte, of the name buffer.

References QFR_cdmDbLoad().

struct _CDM_Database* QFR_cdmDbLoad	(	const QFR_cdmTemplate *	template,
		QFR_fileCtx *	ctx,
		unsigned int	key,
		char *	name,
		unsigned int	name_size
	)			[read]

Utility routine to construct a fully resolve file name to a database, then load it.

Returns:

A handle to the loaded database, or NULL on failure

Parameters:

	ctx	The file resolution context.
	key	The key used to find the specific file
	template	The template containing the list of directory paths and the file name.
	name	Name buffer, if non-NULL, filled in with the resolved file name. The name is NUL-terminated
	name_size	The size, in bytes, of the name buffer.

Referenced by QFR_cdmConstantsLoad().