Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

pmConfig.h File Reference


Detailed Description

Author:
PAP, IfA
Version:
Revision
1.11
Name
rel12
Date:
Date
2006/06/28 00:49:13
Copyright 2004 Maui High Performance Computing Center, University of Hawaii

Definition in file pmConfig.h.

#include "pslib.h"

Include dependency graph for pmConfig.h:

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

Go to the source code of this file.

Data Structures

struct  pmConfig

Enumerations

enum  p_pmRecipeSource { P_PM_RECIPE_SOURCE_NONE = 0x00, P_PM_RECIPE_SOURCE_SITE = 0x01, P_PM_RECIPE_SOURCE_CAMERA = 0x02, P_PM_RECIPE_SOURCE_CL = 0x04, P_PM_RECIPE_SOURCE_ALL = 0x07 }

Functions

pmConfigpmConfigAlloc (int argc, char **argv)
void pmConfigSet (const char *path)
void pmConfigDone (void)
pmConfigpmConfigRead (int argc, char **argv)
 pmConfigRead
bool readConfig (psMetadata **config, const char *name, const char *description)
 we need this elsewhere; make it public
bool pmConfigValidateCameraFormat (const psMetadata *cameraFormat, const psMetadata *header)
 pmConfigValidateCamera
psMetadata * pmConfigCameraFormatFromHeader (pmConfig *config, const psMetadata *header)
 pmConfigCameraFromHeader
psMetadata * pmConfigCameraByName (pmConfig *config, const char *cameraName)
bool pmConfigReadRecipes (pmConfig *config)
 pmConfigRecipeFromCamera
psDB * pmConfigDB (pmConfig *config)
 pmConfigDB
bool pmConfigConformHeader (psMetadata *header, const psMetadata *format)
 pmConfigConformHeader
psArray * pmConfigFileSets (pmConfig *config, char *file, char *list)
bool pmConfigFileSetsMD (psMetadata *metadata, pmConfig *config, char *name, char *file, char *list)


Enumeration Type Documentation

enum p_pmRecipeSource
 

Enumerator:
P_PM_RECIPE_SOURCE_NONE 
P_PM_RECIPE_SOURCE_SITE 
P_PM_RECIPE_SOURCE_CAMERA 
P_PM_RECIPE_SOURCE_CL 
P_PM_RECIPE_SOURCE_ALL 

Definition at line 17 of file pmConfig.h.


Function Documentation

pmConfig* pmConfigAlloc int  argc,
char **  argv
 

psMetadata* pmConfigCameraByName pmConfig config,
const char *  cameraName
 

psMetadata* pmConfigCameraFormatFromHeader pmConfig config,
const psMetadata *  header
 

pmConfigCameraFromHeader

pmConfigCameraFromHeader shall load the camera configuration based on the contents of the FITS header, using the list of known cameras contained in the site configuration. If more than one camera matches the FITS header, a warning shall be generated and the first matching camera returned.

bool pmConfigConformHeader psMetadata *  header,
const psMetadata *  format
 

pmConfigConformHeader

Make the supplied header conform to the nominated camera format.

psDB* pmConfigDB pmConfig config  ) 
 

pmConfigDB

pmConfigDB shall use the site configuration data to open a database handle. This is fairly straightforward at the moment, but will change when we beef up security. (TBD)

void pmConfigDone void   ) 
 

psArray* pmConfigFileSets pmConfig config,
char *  file,
char *  list
 

bool pmConfigFileSetsMD psMetadata *  metadata,
pmConfig config,
char *  name,
char *  file,
char *  list
 

pmConfig* pmConfigRead int  argc,
char **  argv
 

pmConfigRead

pmConfigRead shall load the site configuration (according to the above rule for determining the source). The camera configuration shall also be loaded if it is specified on the command line (argc, argv); otherwise it shall be set to NULL. The recipe shall also be loaded from the command line (if specified) or, if the camera configuration has been loaded, from the camera configuration and recipe specification therein (see below). In dealing with the command line parameters, the functions shall use the appropriate functions in psLib to retrieve and remove the relevant options from the argument list; this simplifies assignment of the mandatory arguments, since all the optional command line arguments are removed leaving only the mandatory arguments. The following psLib setups shall also be performed if they are specified in the site configuration:

bool pmConfigReadRecipes pmConfig config  ) 
 

pmConfigRecipeFromCamera

pmConfigRecipeFromCamera shall load the recipes from the list of known recipes contained in the camera configuration.

void pmConfigSet const char *  path  ) 
 

bool pmConfigValidateCameraFormat const psMetadata *  cameraFormat,
const psMetadata *  header
 

pmConfigValidateCamera

This function, used by pmConfigCameraFromHeader, shall return true if the FITS header matches the rule contained in the camera configuration (see x2.2.2.3); otherwise it shall return false.

bool readConfig psMetadata **  config,
const char *  name,
const char *  description
 

we need this elsewhere; make it public


Generated on Mon Jul 3 14:24:32 2006 for Pan-STARRS Module Library by  doxygen 1.4.4