epr_core.h

Go to the documentation of this file.

/*
 * $Id: epr_core.h,v 1.1.1.1 2004-10-28 19:22:22 norman Exp $
 *
 * Copyright (C) 2002 by Brockmann Consult (info@brockmann-consult.de)
 *
 * 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. This program is distributed in the hope 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 
#ifndef EPR_CORE_H_INCL
#define EPR_CORE_H_INCL
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#include <stdio.h> /* just to get the ANSI-C type FILE */
 
#include "epr_ptrarray.h"
 
struct EPR_API;
struct EPR_Parameter;
 
typedef struct EPR_API EPR_SAPI;
typedef struct EPR_Parameter EPR_SParameter;
 
 
#define EPR_ENVISAT_PRODUCT_MERIS        "MER"
#define EPR_ENVISAT_PRODUCT_ASAR         "ASA"
#define EPR_ENVISAT_PRODUCT_SAR          "SAR"
#define EPR_ENVISAT_PRODUCT_AATSR        "ATS"
 
#define EPR_LONGI_BAND_NAME               "longitude"
 
#define EPR_AATSR_LINES_PER_TIE_PT        32
 
#define EPR_MPH_SIZE                      1247
#define EPR_SPH_SIZE                      11622
#define EPR_DSD_SIZE                      280
 
#define EPR_PRODUCT_MPH_SIZE              1048 /*??????*/
#define EPR_PRODUCT_MAGIC_STR             "PRODUCT=\""
#define EPR_PRODUCT_ID_OFFSET             9
 
#define EPR_PRODUCT_TYPE_ID_STRLEN        10
#define EPR_LENGTH_NUM_DSD_IDENTIFIER     9
#define EPR_COUNT_SEPARATOR_ARRAY         ",*"
#define EPR_IRRELEVANCE_SYMBOL            '*'
#define EPR_FIELD_SEPARATOR_ARRAY         "|"
#define EPR_HEADER_SEPARATOR_ARRAY        "=<>"
#define EPR_HEADER_EXCEPTIONS_ARRAY       "eE"
 
#define EPR_LONGI_ABS_MAX                 180
#define EPR_LONGI_ABS_MIN                 -180
 
#define EPR_LINE_MAX_LENGTH               2000
 
#define EPR_BE_MAGIC_NUMBER  1162761801UL
#define EPR_LE_MAGIC_NUMBER  1230392901UL
#define EPR_LE_MAGIC_BYTE_0  'E'
#define EPR_LE_MAGIC_BYTE_1  'N'
#define EPR_LE_MAGIC_BYTE_2  'V'
#define EPR_LE_MAGIC_BYTE_3  'I'
 
#define EPR_ATS_NUM_PER_POINT_ACROSS_LOCAT      23
#define EPR_ATS_NUM_PER_POINT_ACROSS_SOLAR      11
#define EPR_ATS_LINE_LENGTH                     512
 
#define EPR_ASAR_NUM_PER_POINT_ACROSS_LOCAT     11
 
struct EPR_API {
    epr_boolean init_flag;
 
    int little_endian_order;
 
    epr_uint epr_head_size;
 
    /*char* db_dir_path;*/
 
    EPR_ELogLevel log_level;
 
    EPR_FLogHandler log_handler;
 
    EPR_EErrCode last_err_code;
 
    char* last_err_message;
 
    EPR_FErrHandler err_handler;
};
 
 
extern EPR_SAPI epr_api;
 
 
/*
 * ======================================================================
 */
 
void epr_free_product_id(EPR_SProductId* product_id);
 
 
void epr_log(EPR_ELogLevel log_level, const char* log_message);
 
void epr_set_err(EPR_EErrCode err_code, const char* err_message);
 
EPR_SRecord* epr_read_mph(EPR_SProductId* product_id);
 
EPR_SRecord* epr_read_sph(EPR_SProductId* product_id);
 
EPR_EDataTypeId epr_str_to_data_type_id(const char* str);
 
/*
 * Converts the given string into a field length.
 *
 * The string can represent a single integer value or a sequence
 * of integer value and parameter references (names). Integers
 * and value are expected to be separated by the asterisk
 * character ('*'). E.g. the string "3 * 4 * num_pixels_across"
 * is represents a valid field length as long as the parameter
 * name 'num_pixels_across' is found in the given parameter table.
 *
 * @param str the string to be converted
 * @param param_table the parameter table containing the values
 *                    for the parameter references in the string
 * @return the field length computed from the given string or
 *         <code>(uint)-1</code> if an error occured.
 */
/*epr_uint epr_str_to_field_length(const char* str, EPR_SParamTable* param_table);*/
 
char* epr_build_db_file_istream_name(EPR_SProductId* product_id, char* what);
FILE* epr_open_file(char* path_to_file);
int epr_str_to_number(const char* str);
epr_uint epr_parse_value_count(EPR_SProductId* product_id, const char* str);
epr_uint epr_param_to_value(const char* str, EPR_SPtrArray* param_table);
void epr_make_os_compatible_path(char* path);
epr_boolean epr_check_api_init_flag();
 
/*
void epr_make_image_header(EPR_SProductId* product_id, EPR_SDatasetId* dataset_id, EPR_SRecord* record);
int epr_make_image(EPR_SProductId* product_id, EPR_SDatasetId* dataset_id, EPR_SRecord* record);
 */
 
void epr_output_element(const EPR_SField* field, epr_uint field_index, epr_uint element_index, FILE* istream);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* #ifndef EPR_CORE_H_INCL */