Python version of the PolarVolume API. More...

#include "polarvolume.h"

Classes
struct	PyPolarVolume
	The polar volume object. More...

Macros
#define	PyPolarVolume_Type_NUM 0
	index of type

#define	PyPolarVolume_GetNative_NUM 1
	index of GetNative

#define	PyPolarVolume_GetNative_RETURN PolarVolume_t*
	return type for GetNative

#define	PyPolarVolume_GetNative_PROTO (PyPolarVolume*)
	arguments for GetNative

#define	PyPolarVolume_New_NUM 2
	index of New

#define	PyPolarVolume_New_RETURN PyPolarVolume*
	return type for New

#define	PyPolarVolume_New_PROTO (PolarVolume_t*)
	arguments for New

#define	PyPolarVolume_API_pointers 3
	number of type and function pointers

#define	PyPolarVolume_CAPSULE_NAME "_polarvolume._C_API"

#define	PyPolarVolume_GetNative ((PyPolarVolume_GetNative_RETURN ()PyPolarVolume_GetNative_PROTO) PyPolarVolume_API[PyPolarVolume_GetNative_NUM])
	Returns a pointer to the internal polar volume, remember to release the reference when done with the object.

#define	PyPolarVolume_New ((PyPolarVolume_New_RETURN ()PyPolarVolume_New_PROTO) PyPolarVolume_API[PyPolarVolume_New_NUM])
	Creates a new polar volume instance.

#define	PyPolarVolume_Check(op)
	Checks if the object is a python polar volume.

#define	PyPolarVolume_Type ((PyTypeObject)PyPolarVolume_API[PyPolarVolume_Type_NUM])

#define	import_pypolarvolume()
	Imports the PyPolarVolume module (like import _polarvolume in python).

Detailed Description

Python version of the PolarVolume API.

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

Date: 2009-12-08

Macro Definition Documentation

◆ import_pypolarvolume

#define import_pypolarvolume ( )

Value:

PyPolarVolume_API = (void **)PyCapsule_Import(PyPolarVolume_CAPSULE_NAME, 1);

Imports the PyPolarVolume module (like import _polarvolume in python).

◆ PyPolarVolume_API_pointers

#define PyPolarVolume_API_pointers 3

number of type and function pointers

◆ PyPolarVolume_Check

#define PyPolarVolume_Check ( op )

Value:

(Py_TYPE(op) == &PyPolarVolume_Type)

Checks if the object is a python polar volume.

◆ PyPolarVolume_GetNative

#define PyPolarVolume_GetNative (*(PyPolarVolume_GetNative_RETURN (*)PyPolarVolume_GetNative_PROTO) PyPolarVolume_API[PyPolarVolume_GetNative_NUM])

Returns a pointer to the internal polar volume, remember to release the reference when done with the object.

(RAVE_OBJECT_RELEASE).

◆ PyPolarVolume_GetNative_NUM

#define PyPolarVolume_GetNative_NUM 1

index of GetNative

◆ PyPolarVolume_GetNative_PROTO

#define PyPolarVolume_GetNative_PROTO (PyPolarVolume*)

arguments for GetNative

◆ PyPolarVolume_GetNative_RETURN

#define PyPolarVolume_GetNative_RETURN PolarVolume_t*

return type for GetNative

◆ PyPolarVolume_New

#define PyPolarVolume_New (*(PyPolarVolume_New_RETURN (*)PyPolarVolume_New_PROTO) PyPolarVolume_API[PyPolarVolume_New_NUM])

Creates a new polar volume instance.

Release this object with Py_DECREF. If a PolarVolume_t instance is provided and this instance already is bound to a python instance, this instance will be increfed and returned.

Parameters

[in] volume - the PolarVolume_t intance.

Returns: the PyPolarVolume instance.

◆ PyPolarVolume_New_NUM

#define PyPolarVolume_New_NUM 2

index of New

◆ PyPolarVolume_New_PROTO

#define PyPolarVolume_New_PROTO (PolarVolume_t*)

arguments for New

◆ PyPolarVolume_New_RETURN

#define PyPolarVolume_New_RETURN PyPolarVolume*

return type for New

◆ PyPolarVolume_Type_NUM

#define PyPolarVolume_Type_NUM 0

index of type

Classes

Macros