Main Page   Modules   File List   Globals  

Defines | Typedefs | Enumerations | Functions | Variables
beatl2.h File Reference

Defines

#define BEATL2_MAX_NUM_DIMS   8
Error values
Note:
Error values in libbeatl2 start at -2000 in order to keep them seperate from CODA error numbers The value for BEATL2_SUCCESS, which indicates succes, is (just as the value for success in CODA) equal to 0.
#define BEATL2_SUCCESS   (0)
#define BEATL2_ERROR_CODA   (-2000)
#define BEATL2_ERROR_OUT_OF_MEMORY   (-2001)
#define BEATL2_ERROR_HDF4   (-2010)
#define BEATL2_ERROR_NO_HDF4_SUPPORT   (-2011)
#define BEATL2_ERROR_HDF5   (-2012)
#define BEATL2_ERROR_NO_HDF5_SUPPORT   (-2013)
#define BEATL2_ERROR_FILE_OPEN   (-2100)
#define BEATL2_ERROR_FILE_READ   (-2101)
#define BEATL2_ERROR_FILE_WRITE   (-2102)
#define BEATL2_ERROR_PRODUCTFILE_INCONSISTENT   (-2105)
#define BEATL2_ERROR_UNSUPPORTED_PRODUCTFILE   (-2106)
#define BEATL2_ERROR_MULTIPLE_RECORD_TYPES   (-2107)
#define BEATL2_ERROR_INVALID_ARGUMENT   (-2110)
#define BEATL2_ERROR_INVALID_RECORD_TYPE   (-2111)
#define BEATL2_ERROR_INVALID_FIELDNAME   (-2112)
#define BEATL2_ERROR_INVALID_FIELD_INDEX   (-2113)
#define BEATL2_ERROR_INVALID_FIELDNAME_FORMAT   (-2114)
#define BEATL2_ERROR_FIELD_ALREADY_EXISTS   (-2115)
#define BEATL2_ERROR_INCOMPATIBLE_RECORDS   (-2120)
#define BEATL2_ERROR_DIMENSION_SIZE_MISMATCH   (-2121)
#define BEATL2_ERROR_INCOMPATIBLE_FIELDS   (-2122)
#define BEATL2_ERROR_NO_DATA   (-2130)
#define BEATL2_ERROR_FILTER_OPTIONS_SYNTAX   (-2200)
#define BEATL2_ERROR_INVALID_FILTER_OPTION   (-2201)
#define BEATL2_ERROR_INVALID_FILTER_OPTION_VALUE   (-2202)
#define BEATL2_ERROR_PRODUCT_TYPE_FILTER_OPTION_MISSING   (-2204)

Typedefs

typedef enum beatl2_BasicType_enum beatl2_BasicType
typedef struct beatl2_Record_struct beatl2_Record

Enumerations

enum  beatl2_BasicType_enum {
  beatl2_uint8,
  beatl2_int32,
  beatl2_double,
  beatl2_string_ptr
}

Functions

int beatl2_init (void)
void beatl2_done (void)
void beatl2_set_error (const int err, const char *message,...) PRINTF_ATTR
const char * beatl2_errno_to_string (const int err)
int beatl2_ingest (int num_files, const char **filenames, const char *filter, beatl2_Record **record)
beatl2_Recordbeatl2_record_create (void)
void beatl2_record_remove (beatl2_Record *record)
int beatl2_record_get_num_fields (const beatl2_Record *record)
int beatl2_record_get_field_index_from_name (const beatl2_Record *record, const char *field_name)
int beatl2_record_add_field (beatl2_Record *record, const char *field_name, beatl2_BasicType type, int num_dims, long dim[])
int beatl2_record_add_string_field (beatl2_Record *record, const char *field_name, const char *str)
int beatl2_record_remove_field (beatl2_Record *record, int index)
int beatl2_record_attach_field (beatl2_Record *record, const char *field_name, beatl2_BasicType type, int num_dims, long dim[], beatl2_DataType field_data)
int beatl2_record_detach_field (beatl2_Record *record, int index, beatl2_DataType *field_data)
int beatl2_record_get_field_name (const beatl2_Record *record, int index, const char **field_name)
int beatl2_record_get_field_type (const beatl2_Record *record, int index, beatl2_BasicType *type)
int beatl2_record_get_field_dim (const beatl2_Record *record, int index, int *num_dims, long dim[])
int beatl2_record_get_field_num_elements (const beatl2_Record *record, int index, long *num_elements)
int beatl2_record_get_field_data (const beatl2_Record *record, int index, beatl2_DataType *field_data)
int beatl2_record_set_string_data_element (beatl2_DataType field_data, long array_index, const char *str)
int beatl2_record_change_field_name (beatl2_Record *record, int index, const char *field_name)
int beatl2_record_append_data_to_field (beatl2_Record *record, int index, int num_dims, long dim[], beatl2_DataType data)
int beatl2_record_append_field_to_field_by_index (beatl2_Record *record_1, int index_1, const beatl2_Record *record_2, int index_2)
int beatl2_record_append_field_to_field_by_name (beatl2_Record *record_1, const char *field_name_1, const beatl2_Record *record_2, const char *field_name_2)
int beatl2_record_reshape_field_data (beatl2_Record *record, int index, int dim_id, long num_dim_elements, const long *dim_element_id)
int beatl2_record_filter_field_data (beatl2_Record *record, int index, const uint8_t *filter_id)
int beatl2_append (beatl2_Record *record_1, const beatl2_Record *record_2)
int beatl2_find_colocated_data (beatl2_Record *record_1, beatl2_Record *record_2, double time_distance, double radial_distance, double altitude_distance)
int beatl2_slice (beatl2_Record *record, const char *dimension, long num_ids, const long *id)
int beatl2_slice_range (beatl2_Record *record, const char *dimension, long from_id, long to_id)
int beatl2_export (const char *format, const char *filename, const beatl2_Record *record)
int beatl2_import (const char *format, const char *filename, beatl2_Record **record)

Variables

const char * libbeatl2_version
int beatl2_errno

Detailed Description


Define Documentation

#define BEATL2_MAX_NUM_DIMS   8

Maximum number of dimensions of a multidimensional array in a BEATL2 Record Type