RAVE
pycartesianvolume.h File Reference

Python version of the CartesianVolume API. More...

#include "cartesianvolume.h"

Go to the source code of this file.

Classes

struct  PyCartesianVolume
 The cartesian volume object. More...
 

Macros

#define PyCartesianVolume_Type_NUM   0
 index of type
 
#define PyCartesianVolume_GetNative_NUM   1
 index of GetNative
 
#define PyCartesianVolume_GetNative_RETURN   CartesianVolume_t*
 return type for GetNative
 
#define PyCartesianVolume_GetNative_PROTO   (PyCartesianVolume*)
 arguments for GetNative
 
#define PyCartesianVolume_New_NUM   2
 index of New
 
#define PyCartesianVolume_New_RETURN   PyCartesianVolume*
 return type for New
 
#define PyCartesianVolume_New_PROTO   (CartesianVolume_t*)
 arguments for New
 
#define PyCartesianVolume_API_pointers   3
 number of type and function pointers
 
#define PyCartesianVolume_CAPSULE_NAME   "_cartesianvolume._C_API"
 
#define PyCartesianVolume_GetNative    (*(PyCartesianVolume_GetNative_RETURN (*)PyCartesianVolume_GetNative_PROTO) PyCartesianVolume_API[PyCartesianVolume_GetNative_NUM])
 Returns a pointer to the internal cartesian volume, remember to release the reference when done with the object.
 
#define PyCartesianVolume_New    (*(PyCartesianVolume_New_RETURN (*)PyCartesianVolume_New_PROTO) PyCartesianVolume_API[PyCartesianVolume_New_NUM])
 Creates a new cartesian volume instance.
 
#define PyCartesianVolume_Check(op)
 Checks if the object is a python area.
 
#define PyCartesianVolume_Type   (*(PyTypeObject*)PyCartesianVolume_API[PyCartesianVolume_Type_NUM])
 
#define import_pycartesianvolume()
 Imports the PyCartesianVolume module (like import _cartesianvolume in python).
 

Detailed Description

Python version of the CartesianVolume API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2010-06-23

Macro Definition Documentation

◆ import_pycartesianvolume

#define import_pycartesianvolume ( )
Value:
PyCartesianVolume_API = (void **)PyCapsule_Import(PyCartesianVolume_CAPSULE_NAME, 1);

Imports the PyCartesianVolume module (like import _cartesianvolume in python).

◆ PyCartesianVolume_API_pointers

#define PyCartesianVolume_API_pointers   3

number of type and function pointers

◆ PyCartesianVolume_Check

#define PyCartesianVolume_Check ( op)
Value:
(Py_TYPE(op) == &PyCartesianVolume_Type)

Checks if the object is a python area.

◆ PyCartesianVolume_GetNative

#define PyCartesianVolume_GetNative    (*(PyCartesianVolume_GetNative_RETURN (*)PyCartesianVolume_GetNative_PROTO) PyCartesianVolume_API[PyCartesianVolume_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyCartesianVolume_GetNative_NUM

#define PyCartesianVolume_GetNative_NUM   1

index of GetNative

◆ PyCartesianVolume_GetNative_PROTO

#define PyCartesianVolume_GetNative_PROTO   (PyCartesianVolume*)

arguments for GetNative

◆ PyCartesianVolume_GetNative_RETURN

#define PyCartesianVolume_GetNative_RETURN   CartesianVolume_t*

return type for GetNative

◆ PyCartesianVolume_New

#define PyCartesianVolume_New    (*(PyCartesianVolume_New_RETURN (*)PyCartesianVolume_New_PROTO) PyCartesianVolume_API[PyCartesianVolume_New_NUM])

Creates a new cartesian volume instance.

Release this object with Py_DECREF. If a CartesianVolume_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 CartesianVolume_t intance.
Returns
the PyCartesianVolume instance.

◆ PyCartesianVolume_New_NUM

#define PyCartesianVolume_New_NUM   2

index of New

◆ PyCartesianVolume_New_PROTO

#define PyCartesianVolume_New_PROTO   (CartesianVolume_t*)

arguments for New

◆ PyCartesianVolume_New_RETURN

#define PyCartesianVolume_New_RETURN   PyCartesianVolume*

return type for New

◆ PyCartesianVolume_Type_NUM

#define PyCartesianVolume_Type_NUM   0

index of type