pyiocache.c File Reference

Python version of the RaveIOCache API. More...

#include "pyravecompat.h"
#include "rave_iocache.h"
#include "rave_object.h"
#include <limits.h>
#include <math.h>
#include <stdio.h>
#include <string.h>
#include "pyiocache.h"
#include "pyravefield.h"
#include "pyrave_debug.h"
#include "rave_alloc.h"
#include "hlhdf.h"
#include "hlhdf_debug.h"

Macros
#define	PYRAVEIOCACHE_MODULE
	include correct part of pyiocache.h
#define	raiseException_gotoTag(tag, type, msg)
	Sets a python exception and goto tag.
#define	raiseException_returnNULL(type, msg)
	Sets a python exception and returns NULL.

Functions
	PYRAVE_DEBUG_MODULE ("_iocache")
	Name of the module debugged.
	PyDoc_STRVAR (_pyraveiocache_doc, "This instance wraps the IO-routines used when writing and/or reading static fields using RAVE.\n" "\n" " * compression_level- The compression level beeing used. Range between 0 and 9 where 0 means no compression and 9 means highest compression.\n" " Compression level 1 is lowest compression ratio but fastest and level 9 is highest compression ratio but slowest.\n " "\n" "The below fcp_<members> are all used for optimizing the file storage. Please refer to HDF5 documentation for more information.\n" " * fcp_userblock - Integer value." "\n" " * fcp_sizes - Sizes must be a tuple containing 2 integers representing (size, addr).\n" "\n" " * fcp_symk - Symk must be a tuple containing 2 integers representing (ik, lk).\n" "\n" " * fcp_istorek - Integer value.\n" "\n" " * fcp_metablocksize- Integer value.\n" "\n")
	PyDoc_STRVAR (_pyraveiocache_module_doc, "This class provides functionality for reading and writing cache files used within RAVE.\n" "\n" "This documentation will only provide information about H5 since this is the format used for static data fields in rave.\n" "\n" "To read a cache-file:\n" ">>> import _iocache\n" ">>> obj = _iocache.loadField(\"/var/cache/baltrad/clutter/seang.h5\")\n" "\n")
	Adds constants to the dictionary (probably the modules dictionary).
	MOD_INIT (_iocache)

Variables
PyTypeObject	PyRaveIOCache_Type

Detailed Description

Python version of the RaveIOCache API.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2024-02-05

Macro Definition Documentation

PYRAVEIOCACHE_MODULE

#define PYRAVEIOCACHE_MODULE

include correct part of pyiocache.h

raiseException_gotoTag

#define raiseException_gotoTag	(		tag,
			type,
			msg )

Value:

{PyErr_SetString(type, msg); goto tag;}

Sets a python exception and goto tag.

raiseException_returnNULL

#define raiseException_returnNULL	(		type,
			msg )

Value:

{PyErr_SetString(type, msg); return NULL;}

Sets a python exception and returns NULL.

Function Documentation

PyDoc_STRVAR()

PyDoc_STRVAR	(	_pyraveiocache_module_doc	,
		"This class provides functionality for reading and writing cache files used within RAVE.\n" "\n" "This documentation will only provide information about H5 since this is the format used for static data fields in rave.\n" "\n" "To read a cache-file:\n" ">>	,
		import _iocache\n" "> >	)

Adds constants to the dictionary (probably the modules dictionary).

Parameters

[in]	dictionary	- the dictionary the long should be added to
[in]	name	- the name of the constant
[in]	value	- the value

PYRAVE_DEBUG_MODULE()

PYRAVE_DEBUG_MODULE

(

"_iocache"

)

Name of the module debugged.