RAVE
pyacrr.h File Reference

Python version of the Acrr API. More...

#include "Python.h"
#include "rave_acrr.h"

Go to the source code of this file.

Classes

struct  PyAcrr
 A cartesian product. More...
 

Macros

#define PyAcrr_Type_NUM   0
 index of type
 
#define PyAcrr_GetNative_NUM   1
 index of GetNative
 
#define PyAcrr_GetNative_RETURN   RaveAcrr_t*
 return type for GetNative
 
#define PyAcrr_GetNative_PROTO   (PyAcrr*)
 arguments for GetNative
 
#define PyAcrr_New_NUM   2
 index of New
 
#define PyAcrr_New_RETURN   PyAcrr*
 return type for New
 
#define PyAcrr_New_PROTO   (RaveAcrr_t*)
 arguments for New
 
#define PyAcrr_API_pointers   3
 number of API pointers
 
#define PyAcrr_CAPSULE_NAME   "_acrr._C_API"
 
#define PyAcrr_GetNative    (*(PyAcrr_GetNative_RETURN (*)PyAcrr_GetNative_PROTO) PyAcrr_API[PyAcrr_GetNative_NUM])
 Returns a pointer to the internal acrr, remember to release the reference when done with the object.
 
#define PyAcrr_New    (*(PyAcrr_New_RETURN (*)PyAcrr_New_PROTO) PyAcrr_API[PyAcrr_New_NUM])
 Creates a new polar scan instance.
 
#define PyAcrr_Check(op)
 Checks if the object is a python acrr instance.
 
#define PyAcrr_Type   (*(PyTypeObject*)PyAcrr_API[PyAcrr_Type_NUM])
 
#define import_pyacrr()
 Imports the PyAcrr module (like import _acrr in python).
 

Detailed Description

Python version of the Acrr API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2012-06-01

Macro Definition Documentation

◆ import_pyacrr

#define import_pyacrr ( )
Value:
PyAcrr_API = (void **)PyCapsule_Import(PyAcrr_CAPSULE_NAME, 1);

Imports the PyAcrr module (like import _acrr in python).

◆ PyAcrr_API_pointers

#define PyAcrr_API_pointers   3

number of API pointers

◆ PyAcrr_Check

#define PyAcrr_Check ( op)
Value:
(Py_TYPE(op) == &PyAcrr_Type)

Checks if the object is a python acrr instance.

◆ PyAcrr_GetNative

#define PyAcrr_GetNative    (*(PyAcrr_GetNative_RETURN (*)PyAcrr_GetNative_PROTO) PyAcrr_API[PyAcrr_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyAcrr_GetNative_NUM

#define PyAcrr_GetNative_NUM   1

index of GetNative

◆ PyAcrr_GetNative_PROTO

#define PyAcrr_GetNative_PROTO   (PyAcrr*)

arguments for GetNative

◆ PyAcrr_GetNative_RETURN

#define PyAcrr_GetNative_RETURN   RaveAcrr_t*

return type for GetNative

◆ PyAcrr_New

#define PyAcrr_New    (*(PyAcrr_New_RETURN (*)PyAcrr_New_PROTO) PyAcrr_API[PyAcrr_New_NUM])

Creates a new polar scan instance.

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

Parameters
[in]area- the RaveAcrr_t intance.
Returns
the PyAcrr instance.

◆ PyAcrr_New_NUM

#define PyAcrr_New_NUM   2

index of New

◆ PyAcrr_New_PROTO

#define PyAcrr_New_PROTO   (RaveAcrr_t*)

arguments for New

◆ PyAcrr_New_RETURN

#define PyAcrr_New_RETURN   PyAcrr*

return type for New

◆ PyAcrr_Type_NUM

#define PyAcrr_Type_NUM   0

index of type