RAVE
pyravedata2d.h File Reference

Python version of the RaveData2D API. More...

#include "rave_data2d.h"

Go to the source code of this file.

Classes

struct  PyRaveData2D
 The rave field object. More...
 

Macros

#define PyRaveData2D_Type_NUM   0
 index of type
 
#define PyRaveData2D_GetNative_NUM   1
 index of GetNative
 
#define PyRaveData2D_GetNative_RETURN   RaveData2D_t*
 return type for GetNative
 
#define PyRaveData2D_GetNative_PROTO   (PyRaveData2D*)
 arguments for GetNative
 
#define PyRaveData2D_New_NUM   2
 index of New
 
#define PyRaveData2D_New_RETURN   PyRaveData2D*
 return type for New
 
#define PyRaveData2D_New_PROTO   (RaveData2D_t*)
 arguments for New
 
#define PyRaveData2D_API_pointers   3
 number of type and function pointers
 
#define PyRaveData2D_CAPSULE_NAME   "_ravedata2d._C_API"
 
#define PyRaveData2D_GetNative    (*(PyRaveData2D_GetNative_RETURN (*)PyRaveData2D_GetNative_PROTO) PyRaveData2D_API[PyRaveData2D_GetNative_NUM])
 Returns a pointer to the internal field, remember to release the reference when done with the object.
 
#define PyRaveData2D_New    (*(PyRaveData2D_New_RETURN (*)PyRaveData2D_New_PROTO) PyRaveData2D_API[PyRaveData2D_New_NUM])
 Creates a new rave data 2d instance.
 
#define PyRaveData2D_Check(op)
 Checks if the object is a python rave data 2d.
 
#define PyRaveData2D_Type   (*(PyTypeObject*)PyRaveData2D_API[PyRaveData2D_Type_NUM])
 
#define import_ravedata2d()
 Imports the PyArea module (like import _area in python).
 

Detailed Description

Python version of the RaveData2D API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2019-02-18

Macro Definition Documentation

◆ import_ravedata2d

#define import_ravedata2d ( )
Value:
PyRaveData2D_API = (void **)PyCapsule_Import(PyRaveData2D_CAPSULE_NAME, 1);

Imports the PyArea module (like import _area in python).

◆ PyRaveData2D_API_pointers

#define PyRaveData2D_API_pointers   3

number of type and function pointers

◆ PyRaveData2D_Check

#define PyRaveData2D_Check ( op)
Value:
(Py_TYPE(op) == &PyRaveData2D_Type)

Checks if the object is a python rave data 2d.

◆ PyRaveData2D_GetNative

#define PyRaveData2D_GetNative    (*(PyRaveData2D_GetNative_RETURN (*)PyRaveData2D_GetNative_PROTO) PyRaveData2D_API[PyRaveData2D_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyRaveData2D_GetNative_NUM

#define PyRaveData2D_GetNative_NUM   1

index of GetNative

◆ PyRaveData2D_GetNative_PROTO

#define PyRaveData2D_GetNative_PROTO   (PyRaveData2D*)

arguments for GetNative

◆ PyRaveData2D_GetNative_RETURN

#define PyRaveData2D_GetNative_RETURN   RaveData2D_t*

return type for GetNative

◆ PyRaveData2D_New

#define PyRaveData2D_New    (*(PyRaveData2D_New_RETURN (*)PyRaveData2D_New_PROTO) PyRaveData2D_API[PyRaveData2D_New_NUM])

Creates a new rave data 2d instance.

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

Parameters
[in]field- the RaveData2D_t intance.
Returns
the PyRaveData2D instance.

◆ PyRaveData2D_New_NUM

#define PyRaveData2D_New_NUM   2

index of New

◆ PyRaveData2D_New_PROTO

#define PyRaveData2D_New_PROTO   (RaveData2D_t*)

arguments for New

◆ PyRaveData2D_New_RETURN

#define PyRaveData2D_New_RETURN   PyRaveData2D*

return type for New

◆ PyRaveData2D_Type_NUM

#define PyRaveData2D_Type_NUM   0

index of type