_dba_varinfo Struct Reference

#include <vartable.h>


Detailed Description

Holds the information about a DBALLE variable.

It never needs to be deallocated, as all the dba_varinfo returned by DB-ALLe are pointers to memory-cached versions that are guaranteed to exist for all the lifetime of the program.

Data Fields

dba_varcode var
 The variable code.
char desc [64]
 The variable description.
char unit [24]
 The measurement unit of the variable.
int scale
 The scale of the variable.
int ref
 The reference value for the variable.
int len
 The length in digits of the integer representation of this variable (after scaling and changing reference value).
int bit_ref
 The reference value for bit-encoding.
int bit_len
 The length in bits of the variable when encoded in a bit string (after scaling and changing reference value).
int is_string
 True if the variable is a string; false if it is a numeric value.
int imin
 Minimum unscaled value the field can have.
int imax
 Maximum unscaled value the field can have.
double dmin
 Minimum scaled value the field can have.
double dmax
 Maximum scaled value the field can have.
dba_alteration alteration
 C-table alteration that has been applied to this entry.
struct _dba_varinfoalterations
 Othere altered versions of this varinfo.


Field Documentation

The variable code.

See DBA_VAR, DBA_VAR_X, DBA_VAR_Y.

The variable description.

Referenced by dba_record_parse_date_extremes().

The measurement unit of the variable.

Referenced by dba_var_copy_val().

The scale of the variable.

When the variable is represented as an integer, it is multiplied by 10**scale

Referenced by dba_var_decode_int(), dba_var_encode_int(), and dba_vartable_query_altered().

The reference value for the variable.

When the variable is represented as an integer, and after scaling, it is added this value

Referenced by dba_var_decode_int(), and dba_var_encode_int().

The reference value for bit-encoding.

When the variable is encoded in a bit string, it is added this value


The documentation for this struct was generated from the following file:

Generated on Fri Aug 1 15:20:53 2008 for libdballe by  doxygen 1.5.6