RAVE
pycartesiancomposite.h File Reference

Python version of the CartesianComposite API. More...

Go to the source code of this file.

Classes

struct  PyCartesianComposite
 A cartesian product. More...
 

Macros

#define PyCartesianComposite_Type_NUM   0
 index of type
 
#define PyCartesianComposite_GetNative_NUM   1
 index of GetNative
 
#define PyCartesianComposite_GetNative_RETURN   CartesianComposite_t*
 return type for GetNative
 
#define PyCartesianComposite_GetNative_PROTO   (PyCartesianComposite*)
 arguments for GetNative
 
#define PyCartesianComposite_New_NUM   2
 index of New
 
#define PyCartesianComposite_New_RETURN   PyCartesianComposite*
 return type for New
 
#define PyCartesianComposite_New_PROTO   (CartesianComposite_t*)
 arguments for New
 
#define PyCartesianComposite_API_pointers   3
 number of api pointers
 
#define PyCartesianComposite_CAPSULE_NAME   "_cartesiancomposite._C_API"
 
#define PyCartesianComposite_GetNative    (*(PyCartesianComposite_GetNative_RETURN (*)PyCartesianComposite_GetNative_PROTO) PyCartesianComposite_API[PyCartesianComposite_GetNative_NUM])
 Returns a pointer to the internal cartesian, remember to release the reference when done with the object.
 
#define PyCartesianComposite_New    (*(PyCartesianComposite_New_RETURN (*)PyCartesianComposite_New_PROTO) PyCartesianComposite_API[PyCartesianComposite_New_NUM])
 Creates a new cartesian instance.
 
#define PyCartesianComposite_Check(op)
 Checks if the object is a python cartesian composite generator.
 
#define PyCartesianComposite_Type   (*(PyTypeObject*)PyCartesianComposite_API[PyCartesianComposite_Type_NUM])
 
#define import_pycartesiancomposite()
 Imports the PyArea module (like import _cartesiancomposite in python).
 

Detailed Description

Python version of the CartesianComposite API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2013-10-09

Macro Definition Documentation

◆ import_pycartesiancomposite

#define import_pycartesiancomposite ( )
Value:
PyCartesianComposite_API = (void **)PyCapsule_Import(PyCartesianComposite_CAPSULE_NAME, 1);

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

◆ PyCartesianComposite_API_pointers

#define PyCartesianComposite_API_pointers   3

number of api pointers

◆ PyCartesianComposite_Check

#define PyCartesianComposite_Check ( op)
Value:
(Py_TYPE(op) == &PyCartesianComposite_Type)

Checks if the object is a python cartesian composite generator.

◆ PyCartesianComposite_GetNative

#define PyCartesianComposite_GetNative    (*(PyCartesianComposite_GetNative_RETURN (*)PyCartesianComposite_GetNative_PROTO) PyCartesianComposite_API[PyCartesianComposite_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyCartesianComposite_GetNative_NUM

#define PyCartesianComposite_GetNative_NUM   1

index of GetNative

◆ PyCartesianComposite_GetNative_PROTO

#define PyCartesianComposite_GetNative_PROTO   (PyCartesianComposite*)

arguments for GetNative

◆ PyCartesianComposite_GetNative_RETURN

#define PyCartesianComposite_GetNative_RETURN   CartesianComposite_t*

return type for GetNative

◆ PyCartesianComposite_New

#define PyCartesianComposite_New    (*(PyCartesianComposite_New_RETURN (*)PyCartesianComposite_New_PROTO) PyCartesianComposite_API[PyCartesianComposite_New_NUM])

Creates a new cartesian instance.

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

Parameters
[in]generator- the CartesianComposite_t intance.
Returns
the PyCartesianComposite instance.

◆ PyCartesianComposite_New_NUM

#define PyCartesianComposite_New_NUM   2

index of New

◆ PyCartesianComposite_New_PROTO

#define PyCartesianComposite_New_PROTO   (CartesianComposite_t*)

arguments for New

◆ PyCartesianComposite_New_RETURN

#define PyCartesianComposite_New_RETURN   PyCartesianComposite*

return type for New

◆ PyCartesianComposite_Type_NUM

#define PyCartesianComposite_Type_NUM   0

index of type