RAVE
pyqitotal.h File Reference

Python version of the QI total algorithm. More...

#include "rave_qitotal.h"

Go to the source code of this file.

Classes

struct  PyQITotal
 A qi total object. More...
 

Macros

#define PyQITotal_Type_NUM   0
 index for Type
 
#define PyQITotal_GetNative_NUM   1
 index for GetNative
 
#define PyQITotal_GetNative_RETURN   RaveQITotal_t*
 return type for GetNative
 
#define PyQITotal_GetNative_PROTO   (PyQITotal*)
 argument prototype for GetNative
 
#define PyQITotal_New_NUM   2
 index for New
 
#define PyQITotal_New_RETURN   PyQITotal*
 return type for New
 
#define PyQITotal_New_PROTO   (RaveQITotal_t*)
 argument prototype for New
 
#define PyQITotal_API_pointers   3
 number of function and variable pointers
 
#define PyQITotal_CAPSULE_NAME   "_qitotal._C_API"
 
#define PyQITotal_GetNative    (*(PyQITotal_GetNative_RETURN (*)PyQITotal_GetNative_PROTO) PyQITotal_API[PyQITotal_GetNative_NUM])
 Returns a pointer to the internal qi total, remember to release the reference when done with the object.
 
#define PyQITotal_New    (*(PyQITotal_New_RETURN (*)PyQITotal_New_PROTO) PyQITotal_API[PyQITotal_New_NUM])
 Creates a new qi total instance.
 
#define PyQITotal_Check(op)
 Checks if the object is a python qi total instance.
 
#define PyQITotal_Type   (*(PyTypeObject*)PyQITotal_API[PyQITotal_Type_NUM])
 
#define import_qitotal()
 Imports the PyArea module (like import _area in python).
 

Detailed Description

Python version of the QI total algorithm.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2014-02-27

Macro Definition Documentation

◆ import_qitotal

#define import_qitotal ( )
Value:
PyQITotal_API = (void **)PyCapsule_Import(PyQITotal_CAPSULE_NAME, 1);

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

◆ PyQITotal_API_pointers

#define PyQITotal_API_pointers   3

number of function and variable pointers

◆ PyQITotal_Check

#define PyQITotal_Check ( op)
Value:
(Py_TYPE(op) == &PyQITotal_Type)

Checks if the object is a python qi total instance.

◆ PyQITotal_GetNative

#define PyQITotal_GetNative    (*(PyQITotal_GetNative_RETURN (*)PyQITotal_GetNative_PROTO) PyQITotal_API[PyQITotal_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyQITotal_GetNative_NUM

#define PyQITotal_GetNative_NUM   1

index for GetNative

◆ PyQITotal_GetNative_PROTO

#define PyQITotal_GetNative_PROTO   (PyQITotal*)

argument prototype for GetNative

◆ PyQITotal_GetNative_RETURN

#define PyQITotal_GetNative_RETURN   RaveQITotal_t*

return type for GetNative

◆ PyQITotal_New

#define PyQITotal_New    (*(PyQITotal_New_RETURN (*)PyQITotal_New_PROTO) PyQITotal_API[PyQITotal_New_NUM])

Creates a new qi total instance.

Release this object with Py_DECREF. If the passed RaveQITotal_t instance is bound to a python instance, this instance will be increfed and returned.

Parameters
[in]qitotal- the RaveQITotal_t instance.
Returns
the PyQITotal instance.

◆ PyQITotal_New_NUM

#define PyQITotal_New_NUM   2

index for New

◆ PyQITotal_New_PROTO

#define PyQITotal_New_PROTO   (RaveQITotal_t*)

argument prototype for New

◆ PyQITotal_New_RETURN

#define PyQITotal_New_RETURN   PyQITotal*

return type for New

◆ PyQITotal_Type_NUM

#define PyQITotal_Type_NUM   0

index for Type