record.h

Go to the documentation of this file.

/*
 * DB-ALLe - Archive for punctual meteorological data
 *
 * Copyright (C) 2005,2008  ARPA-SIM <urpsim@smr.arpa.emr.it>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * Author: Enrico Zini <enrico@enricozini.com>
 */

#ifndef DBA_RECORD_H
#define DBA_RECORD_H

#ifdef  __cplusplus
extern "C" {
#endif

#include <dballe/core/error.h>
#include <dballe/core/var.h>

enum _dba_keyword {
    DBA_KEY_ERROR       = -1,
    DBA_KEY_PRIORITY    =  0,
    DBA_KEY_PRIOMAX     =  1,
    DBA_KEY_PRIOMIN     =  2,
    DBA_KEY_REP_COD     =  3,
    DBA_KEY_REP_MEMO    =  4,
    DBA_KEY_ANA_ID      =  5,
    DBA_KEY_MOBILE      =  6,
    DBA_KEY_IDENT       =  7,
    DBA_KEY_LAT         =  8,
    DBA_KEY_LON         =  9,
    DBA_KEY_LATMAX      = 10,
    DBA_KEY_LATMIN      = 11,
    DBA_KEY_LONMAX      = 12,
    DBA_KEY_LONMIN      = 13,
    DBA_KEY_YEAR        = 14,
    DBA_KEY_MONTH       = 15,
    DBA_KEY_DAY         = 16,
    DBA_KEY_HOUR        = 17,
    DBA_KEY_MIN         = 18,
    DBA_KEY_SEC         = 19,
    DBA_KEY_YEARMAX     = 20,
    DBA_KEY_YEARMIN     = 21,
    DBA_KEY_MONTHMAX    = 22,
    DBA_KEY_MONTHMIN    = 23,
    DBA_KEY_DAYMAX      = 24,
    DBA_KEY_DAYMIN      = 25,
    DBA_KEY_HOURMAX     = 26,
    DBA_KEY_HOURMIN     = 27,
    DBA_KEY_MINUMAX     = 28,
    DBA_KEY_MINUMIN     = 29,
    DBA_KEY_SECMAX      = 30,
    DBA_KEY_SECMIN      = 31,
    DBA_KEY_LEVELTYPE1  = 32,
    DBA_KEY_L1          = 33,
    DBA_KEY_LEVELTYPE2  = 34,
    DBA_KEY_L2          = 35,
    DBA_KEY_PINDICATOR  = 36,
    DBA_KEY_P1          = 37,
    DBA_KEY_P2          = 38,
    DBA_KEY_VAR         = 39,
    DBA_KEY_VARLIST     = 40,
    DBA_KEY_CONTEXT_ID  = 41,
    DBA_KEY_QUERY       = 42,
    DBA_KEY_ANA_FILTER  = 43,
    DBA_KEY_DATA_FILTER = 44,
    DBA_KEY_ATTR_FILTER = 45,
    DBA_KEY_LIMIT       = 46,
    DBA_KEY_VAR_RELATED = 47,
    DBA_KEY_COUNT       = 48,
};
typedef enum _dba_keyword dba_keyword;

/* TODO: should be deleted after checking if dbavm uses them */
#if 0
/* Shortcuts for commonly used variables */
#define DBA_VAR_BLOCK       DBA_VAR(0,  1,   1)
#define DBA_VAR_STATION     DBA_VAR(0,  1,   2)
#define DBA_VAR_NAME        DBA_VAR(0,  1,  19)
#define DBA_VAR_HEIGHT      DBA_VAR(0,  7,   1)
#define DBA_VAR_HEIGHTBARO  DBA_VAR(0,  7,  31)
#define DBA_VAR_DATA_ID     DBA_VAR(0, 33, 195)
#endif

struct _dba_record;
struct _dba_item;

typedef struct _dba_record* dba_record;

typedef struct _dba_item* dba_record_cursor;

const char* dba_record_keyword_name(dba_keyword keyword);

dba_err dba_record_keyword_info(dba_keyword keyword, dba_varinfo* info);

dba_keyword dba_record_keyword_byname(const char* tag);

dba_keyword dba_record_keyword_byname_len(const char* tag, int len);

dba_err dba_record_create(dba_record* rec);

void dba_record_delete(dba_record rec);

void dba_record_clear(dba_record rec);

void dba_record_clear_vars(dba_record rec);

dba_err dba_record_copy(dba_record dest, dba_record source);

dba_err dba_record_add(dba_record dest, dba_record source);

dba_err dba_record_difference(dba_record dest, dba_record source1, dba_record source2);

int dba_record_equals(dba_record rec1, dba_record rec2);

dba_var dba_record_key_peek(dba_record rec, dba_keyword parameter);

dba_var dba_record_var_peek(dba_record rec, dba_varcode code);

const char* dba_record_key_peek_value(dba_record rec, dba_keyword parameter);

const char* dba_record_var_peek_value(dba_record rec, dba_varcode code);

dba_err dba_record_contains(dba_record rec, const char* name, int* found);

dba_err dba_record_contains_key(dba_record rec, dba_keyword parameter, int* found);

dba_err dba_record_contains_var(dba_record rec, dba_varcode code, int* found);

dba_err dba_record_enq(dba_record rec, const char* name, dba_var* var);

dba_err dba_record_key_enq(dba_record rec, dba_keyword parameter, dba_var* var);

dba_err dba_record_var_enq(dba_record rec, dba_varcode code, dba_var* var);

dba_err dba_record_enqi(dba_record rec, const char* name, int* value, int* found);

dba_err dba_record_key_enqi(dba_record rec, dba_keyword parameter, int* value, int* found);

dba_err dba_record_var_enqi(dba_record rec, dba_varcode code, int* value, int* found);

dba_err dba_record_enqd(dba_record rec, const char* name, double* value, int* found);

dba_err dba_record_key_enqd(dba_record rec, dba_keyword parameter, double* value, int* found);

dba_err dba_record_var_enqd(dba_record rec, dba_varcode code, double* value, int* found);

dba_err dba_record_enqc(dba_record rec, const char* name, const char** value);

dba_err dba_record_key_enqc(dba_record rec, dba_keyword parameter, const char** value);

dba_err dba_record_var_enqc(dba_record rec, dba_varcode code, const char** value);

dba_err dba_record_key_set(dba_record rec, dba_keyword parameter, dba_var var);

dba_err dba_record_var_set(dba_record rec, dba_varcode code, dba_var var);

dba_err dba_record_var_set_direct(dba_record rec, dba_var var);

dba_err dba_record_set_ana_context(dba_record rec);

dba_err dba_record_key_seti(dba_record rec, dba_keyword parameter, int value);

dba_err dba_record_var_seti(dba_record rec, dba_varcode code, int value);

dba_err dba_record_key_setd(dba_record rec, dba_keyword parameter, double value);

dba_err dba_record_var_setd(dba_record rec, dba_varcode code, double value);

dba_err dba_record_key_setc(dba_record rec, dba_keyword parameter, const char* value);

dba_err dba_record_var_setc(dba_record rec, dba_varcode code, const char* value);

dba_err dba_record_set_from_string(dba_record rec, const char* str);

dba_err dba_record_key_unset(dba_record rec, dba_keyword parameter);

dba_err dba_record_var_unset(dba_record rec, dba_varcode code);

void dba_record_print(dba_record rec, FILE* out);

void dba_record_diff(dba_record rec1, dba_record rec2, int* diffs, FILE* out);

dba_record_cursor dba_record_iterate_first(dba_record rec);

dba_record_cursor dba_record_iterate_next(dba_record rec, dba_record_cursor cur);

dba_var dba_record_cursor_variable(dba_record_cursor cur);

dba_err dba_record_parse_date_extremes(dba_record rec, int* minvalues, int* maxvalues);

#ifdef  __cplusplus
}
#endif

/* vim:set ts=4 sw=4: */
#endif

---