base/export/libs/util/keymap.h

Go to the documentation of this file.

/* keymap.h */

#include "hcontainer.h"

#ifndef _EXPUTL_KEYMAP_H
#define _EXPUTL_KEYMAP_H



/* Begin API */
/************ Exporting FITS files ***************/
typedef enum Exputl_KeyMapClass_enum {
   kKEYMAPCLASS_DEFAULT = 0,
   kKEYMAPCLASS_DSDS = 1,
   kKEYMAPCLASS_LOCAL = 2,
   kKEYMAPCLASS_SSW = 3,
   kKEYMAPCLASS_GNG = 4,
   kKEYMAPCLASS_NUMTABLESPLUSONE
   /* xxx etc*/
} Exputl_KeyMapClass_t;

struct Exputl_KeyMap_struct {
  HContainer_t int2ext;
  HContainer_t ext2int;
}; 

typedef struct Exputl_KeyMap_struct Exputl_KeyMap_t;

/* These should be cleaned up by DRMS, not by jsoc_main */
int exputl_keymap_init(void);
void exputl_keymap_term(void *data);

/* Get external/internal keyword name. Modules/programs should use
 * drms_keyword keywords to convert between internal DRMS keywords
 * and external FITS-file keywords, and vice versa.
*/
const char *exputl_keymap_extname(Exputl_KeyMap_t *keymap, const char *intName);
const char *exputl_keymap_classidextname(Exputl_KeyMapClass_t, const char *intName);
const char *exputl_keymap_classextname(const char *class, const char *intName);
const char *exputl_keymap_intname(Exputl_KeyMap_t *keymap, const char *extName);
const char *exputl_keymap_classidintname(Exputl_KeyMapClass_t, const char *extName);
const char *exputl_keymap_classintname(const char *class, const char *extName);

/* Functions to create and free EXPUTL keymaps. */

/* Functions to create and free the global class EXPUTL keymaps */
Exputl_KeyMap_t *exputl_keymap_create(void);
void exputl_keymap_destroy(Exputl_KeyMap_t **km);
int exputl_keymap_parsetable(Exputl_KeyMap_t *keymap, const char *text);
int exputl_keymap_parsefile(Exputl_KeyMap_t *keymap, FILE *fPtr);
const char *exputl_keymap_getclname(Exputl_KeyMapClass_t clid);


/* End API */

/* Doxygen function documentation */

#endif /* _EXPUTL_KEYMAP_H */

---