base/drms/libs/api/drms_keyword.h

Go to the documentation of this file.

#ifndef _DRMS_KEYWORD_H
#define _DRMS_KEYWORD_H

#include "drms_types.h"
#include "cfitsio.h"
#include "keymap.h"
#include "drms_fitsrw.h"
#include "drms.h"

void drms_keyword_print(DRMS_Keyword_t *key);
void drms_keyword_fprint(FILE *keyfile, DRMS_Keyword_t *key);
void drms_keyword_printval(DRMS_Keyword_t *key);
void drms_keyword_fprintval(FILE *keyfile, DRMS_Keyword_t *key);
void drms_keyword_snprintfval(DRMS_Keyword_t *key, char *buf, int size);
DRMS_Keyword_t *drms_keyword_lookup(DRMS_Record_t *rec, const char *key, int followlink);
DRMS_Keyword_t *drms_template_keyword_followlink(DRMS_Keyword_t *srckey, int *statret);
DRMS_Keyword_t *drms_jsd_template_keyword_followlink(DRMS_Keyword_t *srckey, int *statret);
DRMS_Type_t drms_keyword_type(DRMS_Keyword_t *key);
HContainer_t *drms_keyword_createinfocon(DRMS_Env_t *drmsEnv, 
                      const char *seriesName, 
                      int *status);
void drms_keyword_destroyinfocon(HContainer_t **info);

int drms_keyword_keysmatch(DRMS_Keyword_t *k1, DRMS_Keyword_t *k2);

/************ getkey and setkey family of functions. ************/
/* Versions with type conversion. */
char drms_getkey_char(DRMS_Record_t *rec, const char *key,int *status);
short drms_getkey_short(DRMS_Record_t *rec, const char *key, int *status);
int drms_getkey_int(DRMS_Record_t *rec, const char *key, int *status);
long long drms_getkey_longlong(DRMS_Record_t *rec, const char *key, int *status);
float drms_getkey_float(DRMS_Record_t *rec, const char *key, int *status);
double drms_getkey_double(DRMS_Record_t *rec, const char *key, int *status);
char *drms_getkey_string(DRMS_Record_t *rec, const char *key, int *status);
char *drms_getkey_string(DRMS_Record_t *rec, const char *key, int *status);
TIME drms_getkey_time(DRMS_Record_t *rec, const char *key, int *status);

/* Directly from the keyword */
double drms_keyword_getdouble(DRMS_Keyword_t *keyword, int *status);
TIME drms_keyword_gettime(DRMS_Keyword_t *keyword, int *status);

/* Generic versions. */
DRMS_Type_Value_t drms_getkey(DRMS_Record_t *rec, const char *key, 
                  DRMS_Type_t *type, int *status);
DRMS_Value_t drms_getkey_p(DRMS_Record_t *rec, const char *key, int *status);

/* HISTORY and COMMENT keywords. */
int drms_appendhistory(DRMS_Record_t *rec, const char *str, int newline);
int drms_appendcomment(DRMS_Record_t *rec, const char *str, int newline);

/* Versions with type conversion. */
int drms_setkey_char(DRMS_Record_t *rec, const char *key, char value);
int drms_setkey_short(DRMS_Record_t *rec, const char *key, short value);
int drms_setkey_int(DRMS_Record_t *rec, const char *key, int value);
int drms_setkey_longlong(DRMS_Record_t *rec, const char *key, long long value);
int drms_setkey_float(DRMS_Record_t *rec, const char *key, float value);
int drms_setkey_double(DRMS_Record_t *rec, const char *key, double value);
int drms_setkey_time(DRMS_Record_t *rec, const char *key, TIME value);
int drms_setkey_string(DRMS_Record_t *rec, const char *key, const char *value);
int drms_appkey_string(DRMS_Record_t *rec, const char *key, const char *value);

/* Generic version. */
int drms_setkey(DRMS_Record_t *rec, const char *key, DRMS_Type_t type, 
        DRMS_Type_Value_t *value);

/* Truly POLYMORPHIC versions that don't need to know the actual type. */
int drms_setkey_p(DRMS_Record_t *rec, const char *key, DRMS_Value_t *value);

int drms_keyword_inclass(DRMS_Keyword_t *key, DRMS_KeywordClass_t class);


/* Copy functions. */
int drms_copykey(DRMS_Record_t *target, DRMS_Record_t *source, const char *key);
int drms_copykeyB(DRMS_Keyword_t *tgtkey, DRMS_Keyword_t *srckey);
int drms_copykeys(DRMS_Record_t *target, 
                  DRMS_Record_t *source, 
                  int usesrcset, 
                  DRMS_KeywordClass_t class);

/******** Functions to handle mapping between internal/external keywords **********/

/* Accessor functions */
static inline const char *drms_keyword_getname(DRMS_Keyword_t *key)
{
   return key->info->name;
}
DRMS_Type_t drms_keyword_gettype(DRMS_Keyword_t *key);
const DRMS_Type_Value_t *drms_keyword_getvalue(DRMS_Keyword_t *key);
int drms_keyword_getsegscope(DRMS_Keyword_t *key);
DRMS_RecScopeType_t drms_keyword_getrecscope(DRMS_Keyword_t *key);
const char *drms_keyword_getrecscopestr(DRMS_Keyword_t *key, int *status);
DRMS_SlotKeyUnit_t drms_keyword_getslotunit(DRMS_Keyword_t *key, int *status);

static inline int drms_keyword_getperseg(DRMS_Keyword_t *key)
{
   return ((key->info->kwflags & kKeywordFlag_PerSegment) != 0);
}
static inline void drms_keyword_setperseg(DRMS_Keyword_t *key)
{
   key->info->kwflags |= kKeywordFlag_PerSegment;
}
static inline void drms_keyword_unsetperseg(DRMS_Keyword_t *key)
{
   key->info->kwflags &= ~kKeywordFlag_PerSegment;
}
static inline int drms_keyword_getimplicit(DRMS_Keyword_t *key)
{
   return ((key->info->kwflags & kKeywordFlag_Implicit) != 0);
}
static inline void drms_keyword_setimplicit(DRMS_Keyword_t *key)
{
   key->info->kwflags |= kKeywordFlag_Implicit;
}
static inline void drms_keyword_unsetimplicit(DRMS_Keyword_t *key)
{
   key->info->kwflags &= ~kKeywordFlag_Implicit;
}
static inline int drms_keyword_getintprime(DRMS_Keyword_t *key)
{
   return ((key->info->kwflags & kKeywordFlag_InternalPrime) != 0);
}
static inline void drms_keyword_setintprime(DRMS_Keyword_t *key)
{
   key->info->kwflags |= kKeywordFlag_InternalPrime;
}
static inline void drms_keyword_unsetintprime(DRMS_Keyword_t *key)
{
   key->info->kwflags &= ~kKeywordFlag_InternalPrime;
}
static inline int drms_keyword_getextprime(DRMS_Keyword_t *key)
{
   return ((key->info->kwflags & kKeywordFlag_ExternalPrime) != 0);
}
static inline void drms_keyword_setextprime(DRMS_Keyword_t *key)
{
   key->info->kwflags |= kKeywordFlag_ExternalPrime;
}
static inline void drms_keyword_unsetextprime(DRMS_Keyword_t *key)
{
   key->info->kwflags &= ~kKeywordFlag_ExternalPrime;
}

int drms_keyword_isprime(DRMS_Keyword_t *key);
int drms_keyword_isvariable(DRMS_Keyword_t *key);
int drms_keyword_isconstant(DRMS_Keyword_t *key);
int drms_keyword_isindex(DRMS_Keyword_t *key);
int drms_keyword_isslotted(DRMS_Keyword_t *key);
int drms_keyword_islinked(DRMS_Keyword_t *key);

DRMS_SlotKeyUnit_t drms_keyword_getunit(DRMS_Keyword_t *key, int *status);
TIME drms_keyword_getepoch(DRMS_Keyword_t *epochkey, int *status);
double drms_keyword_getslotcarr0(void);
/* get the epoch value from the epoch keyword associated with the TSEQ-slotted keyword */
TIME drms_keyword_getslotepoch(DRMS_Keyword_t *slotkey, int *status);
/* get the base value from the base keyword associated with the slotted keyword */
double drms_keyword_getslotbase(DRMS_Keyword_t *slotkey, int *status);
/* Generic - get the base value from the base keyword associated with the value keyword */
double drms_keyword_getvalkeybase(DRMS_Keyword_t *valkey, int *status);
double drms_keyword_getslotstep(DRMS_Keyword_t *slotkey, DRMS_SlotKeyUnit_t *unit, int *status);
double drms_keyword_getstep(DRMS_Keyword_t *key, 
                DRMS_RecScopeType_t recscope, 
                DRMS_SlotKeyUnit_t *unit, 
                int *status);
double drms_keyword_getvalkeystep(DRMS_Keyword_t *valkey, int *status);


/* Utility */
DRMS_RecScopeType_t drms_keyword_str2recscope(const char *str, int *status);

/* Generic - get the index keyword from the associated value keyword */
DRMS_Keyword_t *drms_keyword_indexfromvalkey(DRMS_Keyword_t *valkey);

/* Generic - get the base keyword from the associated value keyword */
DRMS_Keyword_t *drms_keyword_basefromvalkey(DRMS_Keyword_t *valkey);

/* Generic - get the step keyword from the associated value keyword */
DRMS_Keyword_t *drms_keyword_stepfromvalkey(DRMS_Keyword_t *valkey);

int drms_keyword_slotval2indexval(DRMS_Keyword_t *slotkey, 
                  DRMS_Value_t *valin,
                  DRMS_Value_t *valout,
                  DRMS_Value_t *startdur);

void drms_keyword_setdate();
TIME drms_keyword_getdate(DRMS_Record_t *rec);

static inline int drms_keyword_ranksort(const void *he1, const void *he2)
{
   DRMS_Keyword_t *k1 = (DRMS_Keyword_t *)hcon_getval(*((HContainerElement_t **)he1));
   DRMS_Keyword_t *k2 = (DRMS_Keyword_t *)hcon_getval(*((HContainerElement_t **)he2));
   
   XASSERT(k1 && k2);

   return (k1->info->rank < k2->info->rank) ? -1 : (k1->info->rank > k2->info->rank ? 1 : 0);
}

/* doxygen documentation */

---