Python API to the ppc options. More...

#include "pyppc_compat.h"
#include "Python.h"
#include <math.h>
#include <stdio.h>
#include <string.h>
#include "pyppcoptions.h"
#include "pyppcradaroptions.h"
#include "pyrave_debug.h"
#include "rave_alloc.h"

Macros
#define	PYPPCOPTIONS_MODULE
	to get correct part in pyppcoptions

#define	raiseException_gotoTag(tag, type, msg)
	Sets a python exception and goto tag.

#define	raiseException_returnNULL(type, msg)
	Sets python exception and returns NULL.

Functions
	PYRAVE_DEBUG_MODULE ("_ppcoptions")
	Debug this module.

	PyDoc_STRVAR (_pyppcoptions_doc, "This is the ppc options loader. It is used to load ppc radar option configuration files written in xml-format.\n" "There are only a few member functions available here (getRadarOptions, exists and options) and currently there is no support for saving the configuration.\n" "\n" " The available functions are: \n" " - radaroptions := getRadarOptions(string)\n" " returns a PpcRadarOptionsCore instance if found\n" " - boolean := exists(string)\n" " returns if the specified option name exists or not\n" " - dictionary := options()\n" " returns a dictionary with all available option settings\n" "\n" ">>> import _ppcoptions\n" ">>> options = _ppcoptions.load(\".../ppc_options.xml\")\n" ">>> optionNames = options.options().keys()\n" ">>> print(optionNames)\n" "dict_keys(['default'])\n" "\n" "Assuming that we are loading a polar scan from sehud and want to use the options configured for that site\n" "one could implement the usage as follows:\n" "\n" ">>> sehudopt = options.getRadarOptions(\"default\")\n" ">>> if options.exists(\"sehud\"):\n" ">>> sehudopt = options.getRadarOptions(\"sehud\")\n" "....\n")

	MOD_INIT (_ppcoptions)

Variables
PyTypeObject	PyPpcOptions_Type

Detailed Description

Python API to the ppc options.

Author: Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date: 2019-02-17

Macro Definition Documentation

◆ PYPPCOPTIONS_MODULE

#define PYPPCOPTIONS_MODULE

to get correct part in pyppcoptions

◆ 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 python exception and returns NULL.

Function Documentation

◆ PYRAVE_DEBUG_MODULE()

PYRAVE_DEBUG_MODULE ( "_ppcoptions" )

Debug this module.

Variable Documentation

◆ PyPpcOptions_Type

PyTypeObject PyPpcOptions_Type

Macros

Functions

Variables