Main Page | Modules | Data Structures | Directories | File List | Data Fields | Examples

Catalog


Detailed Description

CDS Catalog. This object represents a single CDS catalog.


Functions

lnc_catalog * lnc_cat_create (lnc_library *lib, char *cclass, char *cnum, double ra_min, double ra_max, double dec_min, double dec_max, double mag_faint, double mag_bright, int flags)
 Create a new catalog.
lnc_dlist * lnc_cat_query (lnc_catalog *cat)
 Query the datasets in the catalog.
void lnc_cat_free (lnc_catalog *cat)
 Destroys catalog and frees resources.
int lnc_cat_register_class (lnc_object_class *cls)
 Register a new astro object type.


Function Documentation

lnc_catalog * lnc_cat_create lnc_library lib,
char *  cclass,
char *  cnum,
double  ra_min,
double  ra_max,
double  dec_min,
double  dec_max,
double  mag_faint,
double  mag_bright,
int  flags
 

Create a new catalog.

Parameters:
lib Library
cclass Catalog class
cnum Catalog number
ra_min Minimum RA boundary
ra_max Maximum RA boundary
dec_min Minimum Dec boundary
dec_max Maximum Dec boundary
mag_faint Faint magnitude boundary
mag_bright Bright magnitude boundary
flags catalog create flags
Initialise a Catalog by parsing it's ReadMe. The catalog may be limited in sky area and magnitude by using the boundary parameters.
Examples:
client.c, and sky2k.c.

void lnc_cat_free lnc_catalog *  cat  ) 
 

Destroys catalog and frees resources.

Parameters:
cat Catalog
Free's all catalog resources
Examples:
client.c, and sky2k.c.

lnc_dlist * lnc_cat_query lnc_catalog *  cat  ) 
 

Query the datasets in the catalog.

Parameters:
cat Catalog
Returns:
lnc_dlist of lnc_dset_info
Query the datasets within the catalog
Examples:
client.c.

int lnc_cat_register_class lnc_object_class cls  ) 
 

Register a new astro object type.

Parameters:
cls New object class
Returns:
0 on success
Register a new custom object type


Generated on Tue Jul 5 14:34:14 2005 for libncat by  doxygen 1.4.2