c_fimex.h

Go to the documentation of this file.

/*
 * Fimex, c_fimex.h
 *
 * (C) Copyright 2009, met.no
 *
 * Project Info:  https://wiki.met.no/fimex/start
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 *  Created on: Oct 19, 2009
 *      Author: Heiko Klein
 */

#ifndef C_FIMEX_H_
#define C_FIMEX_H_

#include <stddef.h>
#include "fimex/CDMconstants.h"
#include "fimex/deprecated.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct mifi_cdm_reader mifi_cdm_reader;
typedef struct mifi_slicebuilder mifi_slicebuilder;

typedef int (*doubleDatasliceCallbackPtr)(mifi_cdm_reader* reader, const char* varName, size_t unLimDimPos, double* scaledData, size_t dataSize);

extern void mifi_free_cdm_reader(mifi_cdm_reader* reader);

extern mifi_cdm_reader* mifi_new_io_reader(int file_type, const char* filename, const char* configFile);

MIFI_DEPRECATED(mifi_cdm_reader* mifi_new_felt_reader(const char* filename, const char* configFile));

MIFI_DEPRECATED(mifi_cdm_reader* mifi_new_netcdf_reader(const char* filename));

MIFI_DEPRECATED(mifi_cdm_reader* mifi_new_grib_reader(const char* filename, const char* configFile));


MIFI_DEPRECATED(mifi_cdm_reader* mifi_new_ncml_reader(const char* ncmlFile));

extern mifi_cdm_reader* mifi_new_ncml_modifier(mifi_cdm_reader* reader, const char* ncmlFile);



extern int mifi_netcdf_writer(mifi_cdm_reader* reader, const char* filename, const char* configFile, int version);

extern int mifi_grib_writer(mifi_cdm_reader* reader, const char* filename, const char* configFile, int version);


extern int mifi_nullcdm_writer(mifi_cdm_reader* reader);

extern mifi_cdm_reader* mifi_new_cdminterpolator(mifi_cdm_reader* reader, int method, const char* proj_input, const char* out_x_axis, const char* out_y_axis, const char* out_x_axis_unit, const char* out_y_axis_unit);

extern mifi_cdm_reader* mifi_new_lonlat_interpolator(mifi_cdm_reader* reader, int method, int n, const double* lonVals, const double* latVals);


extern mifi_cdm_reader* mifi_new_c_reader(mifi_cdm_reader* reader);

extern int mifi_set_callback_double(mifi_cdm_reader* c_reader, const char* varName, doubleDatasliceCallbackPtr callback);


extern size_t mifi_get_variable_number(mifi_cdm_reader* reader);
extern const char* mifi_get_variable_name(mifi_cdm_reader* reader, size_t pos);

extern unsigned int mifi_get_variable_type(mifi_cdm_reader* reader, const char* varName);

extern size_t mifi_get_dimension_number(mifi_cdm_reader* reader);
extern const char* mifi_get_dimension_name(mifi_cdm_reader* reader, size_t pos);
extern size_t mifi_get_dimension_size(mifi_cdm_reader* reader, const char* dimName);

extern const char* mifi_get_unlimited_dimension_name(mifi_cdm_reader* reader);

extern const char* mifi_get_var_longitude(mifi_cdm_reader* reader, const char* varName);

extern int mifi_get_var_longitude_cpy(mifi_cdm_reader* reader, const char* varName, char* lonName, int n);

extern const char* mifi_get_var_latitude(mifi_cdm_reader* reader, const char* varName);

extern int mifi_get_var_latitude_cpy(mifi_cdm_reader* reader, const char* varName, char* latName, int n);


extern mifi_slicebuilder* mifi_new_slicebuilder(mifi_cdm_reader* reader, const char* varName);
extern int mifi_slicebuilder_has_CS(mifi_slicebuilder* sb);

extern const char* mifi_slicebuilder_get_proj4(mifi_slicebuilder* sb);

extern int mifi_slicebuilder_get_proj4_cpy(mifi_slicebuilder* sb, char* proj4, int n);

extern int mifi_slicebuilder_ndims(mifi_slicebuilder* sb);
extern const char* mifi_slicebuilder_dimname(mifi_slicebuilder* sb, int pos);

extern int mifi_slicebuilder_dimname_cpy(mifi_slicebuilder* sb, int pos, char* dimName, int n);

extern int mifi_slicebuilder_get_start_size(mifi_slicebuilder* sb, unsigned int* start, unsigned int* size);

extern int mifi_slicebuilder_get_axistype(mifi_slicebuilder* sb, int* axistype);


extern int mifi_slicebuilder_set_dim_start_size(mifi_slicebuilder* sb, const char* dimName, unsigned int start, unsigned int size);
extern void mifi_free_slicebuilder(mifi_slicebuilder* sb);



extern int mifi_get_double_dataslice(mifi_cdm_reader* reader, const char* varName, size_t unLimDimPos, double** data, size_t* size);

extern int mifi_get_double_data(mifi_cdm_reader* reader, const char* varName, double** data, size_t* size);

extern int mifi_fill_scaled_double_dataslice(mifi_cdm_reader* reader, const char* varName, mifi_slicebuilder* sb, const char* units, double* data, size_t* size);

extern int mifi_write_scaled_double_dataslice(mifi_cdm_reader* rwreader, const char* varName, mifi_slicebuilder* sb, const char* units, double* data, size_t size);


double mifi_get_unique_forecast_reference_time(mifi_cdm_reader* reader, const char* units);



#ifdef __cplusplus
}
#endif

#endif /* C_FIMEX_H_ */