---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CDM / V0-2-5

Constituent: cdm     Tag: rad750

---

         

---

CDM_pubdefs.h File Reference

Public include file for CDM package. More...

#include "CMX/CMX_asBuiltPub.h"

Include dependency graph for CDM_pubdefs.h:

This graph shows which files directly or indirectly include this file:

Defines
#define	CDM_K_NONE   (0xffff)
Typedefs
typedef _CDM_Database	CDM_Database
	Typedef for struct _CDM_Database.
typedef unsigned int	CDM_cb_ScanDatabase (CDM_Database *cdb, void *prm)
	Signature for an CDM database scanning callback routine.
Functions
unsigned int	CDM_countInstance (unsigned short schema)
	Count instances of a CDM database with a given schema.
CMX_asBuiltIdentity *	CDM_findCAB (CDM_Database *cdb)
	Return the link to the CMX as built identity block.
CDM_Database *	CDM_findDatabase (unsigned short schema, unsigned short instance)
	Find a CDM database by schema and instance.
const void *	CDM_getData (CDM_Database *cdb)
	Return a pointer to the data block of a CDM database instance.
short	CDM_getInstance (CDM_Database *cdb)
	Return the instance number of a CDM database instance.
unsigned int	CDM_getKey (CDM_Database *cdb)
	Return the file key of a CDM database instance.
short	CDM_getSchema (CDM_Database *cdb)
	Return the schema number of a CDM database instance.
short	CDM_getVersion (CDM_Database *cdb)
	Return the version of a CDM database instance.
void	CDM_insertDatabase (CDM_Database *new)
	Insert a CDM database into the database list.
CDM_Database *	CDM_loadDatabase (const char *fil, unsigned int opt)
	Load a CDM database.
void	CDM_removeDatabase (CDM_Database *old)
	Remove a CDM database from the database list.
unsigned int	CDM_scanDatabase (CDM_cb_ScanDatabase *rtn, void *prm)
	Scan though the database instance list.
unsigned int	CDM_unloadDatabase (CDM_Database *cdb)
	Unload a CDM database.

---

Detailed Description

Public include file for CDM package.

CVS $Id: CDM_pubdefs.h,v 1.6 2006/09/15 00:17:45 apw Exp $

---

Function Documentation

unsigned int CDM_countInstance (  unsigned short  schema  )

Count instances of a CDM database with a given schema. Parameters: schema  (in) Database schema Return values: x  Number of instances Count the number of database instances with the given schema.

CMX_asBuiltIdentity* CDM_findCAB (  CDM_Database *  cdb  )

Return the link to the CMX as built identity block. Parameters: cdb  (in) CDM database handle Return values: x  CMX as built identity block pointer 0  Cannot find the CMX as built identity block

CDM_Database* CDM_findDatabase (  unsigned short  schema, unsigned short  instance )

Find a CDM database by schema and instance. Parameters: schema  (in) Database schema instance  (in) Database instance number Return values: x  Handle for database NULL  Database not found Find a CDM database by schema and instance.

const void* CDM_getData (  CDM_Database *  cdb  )

Return a pointer to the data block of a CDM database instance. Parameters: cdb  (in) CDM database handle Return values: x  Pointer to database data block NULL  Invalid database handle

short CDM_getInstance (  CDM_Database *  cdb  )

Return the instance number of a CDM database instance. Parameters: cdb  (in) CDM database handle Return values: x  Instance number CDM_K_NONE  Invalid database handle

unsigned int CDM_getKey (  CDM_Database *  cdb  )

Return the file key of a CDM database instance. Parameters: cdb  (in) CDM database handle Return values: x  File key 0  File key not found

short CDM_getSchema (  CDM_Database *  cdb  )

Return the schema number of a CDM database instance. Parameters: cdb  (in) CDM database handle Return values: x  Database schema number CDM_K_NONE  Invalid database handle

short CDM_getVersion (  CDM_Database *  cdb  )

Return the version of a CDM database instance. Parameters: cdb  (in) CDM database handle Return values: x  Database version CDM_K_NONE  Invalid database handle

void CDM_insertDatabase (  CDM_Database *  new  )

Insert a CDM database into the database list. Parameters: new  (in) CDM database handle Insert a CDM database instance into the database list.

CDM_Database* CDM_loadDatabase (  const char *  fil, unsigned int  opt )

Load a CDM database. Parameters: fil  (in) Filename opt  (in) Options (none currently defined) Return values: x  Handle for database instance NULL  Failure Load a CDM database instance.

void CDM_removeDatabase (  CDM_Database *  old  )

Remove a CDM database from the database list. Parameters: old  (in) CDM database handle Remove a CDM database instance from the database list.

unsigned int CDM_scanDatabase (  CDM_cb_ScanDatabase *  rtn, void *  prm )

Scan though the database instance list. Parameters: rtn  (in) Scan callback routine prm  (in) Scan callback routine parameter Return values: x  Return code from last scan call made. CDM_scanDatabase() scans through the CDM database instance list, calling the provided callback routine for each member. The scan is aborted if the callback routine returns a failure code (least significant bit set).

unsigned int CDM_unloadDatabase (  CDM_Database *  cdb  )

Unload a CDM database. Parameters: cdb  (in) CDM database handle Return values: CDM_HANDLE  Invalid database handle CDM_SUCCESS  Success CDM_UNLOAD  Database unload failed Unload a CDM database instance.

---