rave_io.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2009, 2011 Swedish Meteorological and Hydrological Institute, SMHI,
 
This file is part of RAVE.
 
RAVE 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 3 of the License, or
(at your option) any later version.
 
RAVE 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 RAVE.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef RAVE_IO_H
#define RAVE_IO_H
 
#include "rave_object.h"
#include "rave_types.h"
#include "rave_value.h"

typedef enum RaveIO_ODIM_FileFormat {
  RaveIO_ODIM_FileFormat_UNDEFINED = -1, 
  RaveIO_ODIM_FileFormat_HDF5 = 0,       
  RaveIO_ODIM_FileFormat_BUFR = 1,       
  RaveIO_FileFormat_CF = 2               
} RaveIO_ODIM_FileFormat;

typedef struct _RaveIO_t RaveIO_t;

extern RaveCoreObjectType RaveIO_TYPE;

void RaveIO_close(RaveIO_t* raveio);

RaveIO_t* RaveIO_open(const char* filename, int lazyLoading, const char* preloadQuantities);

RaveIO_t* RaveIO_openFileObject(const char* filename, int lazyLoading, const char* preloadQuantities);

int RaveIO_isHDFFile(const char* filename);

int RaveIO_load(RaveIO_t* raveio, int lazyLoading, const char* preloadQuantities);

int RaveIO_save(RaveIO_t* raveio, const char* filename);

void RaveIO_setObject(RaveIO_t* raveio, RaveCoreObject* object);

RaveCoreObject* RaveIO_getObject(RaveIO_t* raveio);

int RaveIO_setFilename(RaveIO_t* raveio, const char* filename);

const char* RaveIO_getFilename(RaveIO_t* raveio);

Rave_ObjectType RaveIO_getObjectType(RaveIO_t* raveio);

int RaveIO_setOdimVersion(RaveIO_t* raveio, RaveIO_ODIM_Version version);

RaveIO_ODIM_Version RaveIO_getOdimVersion(RaveIO_t* raveio);

RaveIO_ODIM_Version RaveIO_getReadOdimVersion(RaveIO_t* raveio);

int RaveIO_setH5radVersion(RaveIO_t* raveio, RaveIO_ODIM_H5rad_Version version);

RaveIO_ODIM_H5rad_Version RaveIO_getH5radVersion(RaveIO_t* raveio);

RaveIO_ODIM_FileFormat RaveIO_getFileFormat(RaveIO_t* raveio);

void RaveIO_setFileObjectLoading(RaveIO_t* raveio, int override);

int RaveIO_getFileObjectLoading(RaveIO_t* raveio);

int RaveIO_setExtras(RaveIO_t* raveio, RaveValue_t* hashtable);

RaveValue_t* RaveIO_getExtras(RaveIO_t* raveio);

void RaveIO_setStrict(RaveIO_t* raveio, int strict);

int RaveIO_isStrict(RaveIO_t* raveio);

int RaveIO_setFileFormat(RaveIO_t* raveio, RaveIO_ODIM_FileFormat format);

void RaveIO_setCompressionLevel(RaveIO_t* raveio, int lvl);

int RaveIO_getCompressionLevel(RaveIO_t* raveio);

void RaveIO_setUserBlock(RaveIO_t* raveio, unsigned long long userblock);

unsigned long long RaveIO_getUserBlock(RaveIO_t* raveio);

void RaveIO_setSizes(RaveIO_t* raveio, size_t sz, size_t addr);

void RaveIO_getSizes(RaveIO_t* raveio, size_t* sz, size_t* addr);

void RaveIO_setSymk(RaveIO_t* raveio, int ik, int lk);

void RaveIO_getSymk(RaveIO_t* raveio, int* ik, int* lk);

void RaveIO_setIStoreK(RaveIO_t* raveio, long k);

long RaveIO_getIStoreK(RaveIO_t* raveio);

void RaveIO_setMetaBlockSize(RaveIO_t* raveio, long sz);

long RaveIO_getMetaBlockSize(RaveIO_t* raveio);

int RaveIO_setBufrTableDir(RaveIO_t* raveio, const char* dname);

const char* RaveIO_getBufrTableDir(RaveIO_t* raveio);

const char* RaveIO_getErrorMessage(RaveIO_t* raveio);

int RaveIO_supports(RaveIO_ODIM_FileFormat format);
 
 
 
#endif