GEO_DB_schema.h File Reference

CDM database schema: settings for the filter geometry. More...

#include <GEO_DB/TFC_DB_geometry.h>

Classes
struct	_GEO_DB_cmt
	Identifies the geometry in terms of an offline CMT tag version. More...
struct	_GEO_DB_date
	A tag field giving an approximate date of birth of this geometry. More...
struct	_GEO_DB_schema_hdr
	Meta-information about this geometry. More...
struct	_GEO_DB_schema
	The geometry schema. It is a pointer to this structure that is returned by the CDM lookup routine. More...
Defines
#define	GEO_DB_SCHEMA   (0xef)
#define	GEO_DB_VERSION   (2)
#define	GEO_DB_CMT(_origin, _version, _revision, _patch)   { _patch, _revision, _version, _origin }
	Provides a C state suitable for initializing a GEO_DB_cmt structure.
#define	GEO_DB_DATE(_month, _day, _year)   { _day, _month, _year }
	Provides a C statement suitable for initializing a TFC_tagdate structure.
Typedefs
typedef enum _GEO_DB_ORIGIN_K	GEO_DB_ORIGIN_K
	Typedef for enum _GEO_DB_ORIGIN_K.
typedef struct _GEO_DB_cmt	GEO_DB_cmt
	Typedef for struct _GEO_DB_cmt.
typedef struct _GEO_DB_date	GEO_DB_date
	Typedef for struct _GEO_DB_date.
typedef struct _GEO_DB_schema_hdr	GEO_DB_schema_hdr
	Typedef for struct _GEO_DB_schema_hdr.
typedef struct _GEO_DB_schema	GEO_DB_schema
	Typedef for struct _GEO_DB_schema.
Enumerations
enum	_GEO_DB_ORIGIN_K {   GEO_DB_ORIGIN_K_ON_ORBIT = 0,   GEO_DB_ORIGIN_K_GLEAM = 1,   GEO_DB_ORIGIN_K_PRELAUNCH = 2 }
	Enumerates the types of geometries. More...

---

Detailed Description

CDM database schema: settings for the filter geometry.

Author:

J.J. Russell

   CVS $Id: GEO_DB_schema.h,v 1.4 2011/03/25 22:04:45 apw Exp $

---

Define Documentation

#define GEO_DB_CMT	(	_origin,
		_version,
		_revision,
		_patch		)	{ _patch, _revision, _version, _origin }

Provides a C state suitable for initializing a GEO_DB_cmt structure.

Parameters:

	_origin	The geometry origin. i.e. one of GEO_DB_ORIGIN_K's
	_version	The CMT version number
	_revision	The CMT revision number
	_patch	The CMT patch number

#define GEO_DB_DATE	(	_month,
		_day,
		_year		)	{ _day, _month, _year }

Provides a C statement suitable for initializing a TFC_tagdate structure.

Parameters:

	_month	The month of the year (1-12)
	_day	The day of the month
	_year	The year, e.g. 2004

---

Typedef Documentation

GEO_DB_cmt

Typedef for struct _GEO_DB_cmt.

The geometry is tagged with 4 identifying numbers. 3 are the offline CMT tag corresponding to the version, the revision and the patch. In addition a fourth number is added indicating whether this is a GLEAM Monte Carlo geometry or whether it is an geometry to be derived from the actual detector.

GEO_DB_date

Typedef for struct _GEO_DB_date.

This date is meant to be used as a loose indication of the date this geometry came into being. To that end, the resolution is deliberately rather broad, i.e. a day.

GEO_DB_schema_hdr

Typedef for struct _GEO_DB_schema_hdr.

This structure includes four basic identifiers

1. A key
2. The CMT tag
3. The approximate date this geometry was created
4. The approximate date of the last revision

The key is meant to uniquely identify a given geometry. This is likely assigned by the offline and used to point them back to the parent file from which the geometry has been derived.

The two dates are not CVS dates. These are dates which the author of the geometry hand enters. As a result, these dates need not correspond to the date the geometry was committed to FSW code. Rather it should indicate when the geometry was bonafided by the offline.

---

Enumeration Type Documentation

enum _GEO_DB_ORIGIN_K

Enumerates the types of geometries.

Enumerator:

GEO_DB_ORIGIN_K_ON_ORBIT	Geometry is for ON ORBIT data
GEO_DB_ORIGIN_K_GLEAM	Geometry is for GLEAM MC data
GEO_DB_ORIGIN_K_PRELAUNCH	Geometry is for PRELAUNCH data