RAVE
pycompositealgorithm.h File Reference

Python version of the Compositing Algorithm API. More...

#include "Python.h"
#include "composite_algorithm.h"

Go to the source code of this file.

Classes

struct  PyCompositeAlgorithm
 The poo composite algorithm instance. More...
 

Macros

#define PyCompositeAlgorithm_Type_NUM   0
 index of type
 
#define PyCompositeAlgorithm_GetNative_NUM   1
 index of GetNative
 
#define PyCompositeAlgorithm_GetNative_RETURN   CompositeAlgorithm_t*
 return type for GetNative
 
#define PyCompositeAlgorithm_GetNative_PROTO   (PyCompositeAlgorithm*)
 arguments for GetNative
 
#define PyCompositeAlgorithm_New_NUM   2
 index of New
 
#define PyCompositeAlgorithm_New_RETURN   PyCompositeAlgorithm*
 return type for New
 
#define PyCompositeAlgorithm_New_PROTO   (CompositeAlgorithm_t*)
 arguments for New
 
#define PyCompositeAlgorithm_API_pointers   3
 number of type and function pointers
 
#define PyCompositeAlgorithm_CAPSULE_NAME   "_compositealgorithm._C_API"
 
#define PyCompositeAlgorithm_GetNative    (*(PyCompositeAlgorithm_GetNative_RETURN (*)PyCompositeAlgorithm_GetNative_PROTO) PyCompositeAlgorithm_API[PyCompositeAlgorithm_GetNative_NUM])
 Returns a pointer to the internal composite algorithm, remember to release the reference when done with the object.
 
#define PyCompositeAlgorithm_New    (*(PyCompositeAlgorithm_New_RETURN (*)PyCompositeAlgorithm_New_PROTO) PyCompositeAlgorithm_API[PyCompositeAlgorithm_New_NUM])
 Creates a composite algorithm instance.
 
#define PyCompositeAlgorithm_Check(op)
 Checks if the object is a python composite algorithm.
 
#define PyCompositeAlgorithm_Type   (*(PyTypeObject*)PyCompositeAlgorithm_API[PyCompositeAlgorithm_Type_NUM])
 
#define import_compositealgorithm()
 Imports the PyCompositeAlgorithm module (like import _compositealgorithm in python).
 

Detailed Description

Python version of the Compositing Algorithm API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2011-10-28

Macro Definition Documentation

◆ import_compositealgorithm

#define import_compositealgorithm ( )
Value:
PyCompositeAlgorithm_API = (void **)PyCapsule_Import(PyCompositeAlgorithm_CAPSULE_NAME, 1);

Imports the PyCompositeAlgorithm module (like import _compositealgorithm in python).

◆ PyCompositeAlgorithm_API_pointers

#define PyCompositeAlgorithm_API_pointers   3

number of type and function pointers

◆ PyCompositeAlgorithm_Check

#define PyCompositeAlgorithm_Check ( op)
Value:
(Py_TYPE(op) == &PyCompositeAlgorithm_Type)

Checks if the object is a python composite algorithm.

◆ PyCompositeAlgorithm_GetNative

#define PyCompositeAlgorithm_GetNative    (*(PyCompositeAlgorithm_GetNative_RETURN (*)PyCompositeAlgorithm_GetNative_PROTO) PyCompositeAlgorithm_API[PyCompositeAlgorithm_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyCompositeAlgorithm_GetNative_NUM

#define PyCompositeAlgorithm_GetNative_NUM   1

index of GetNative

◆ PyCompositeAlgorithm_GetNative_PROTO

#define PyCompositeAlgorithm_GetNative_PROTO   (PyCompositeAlgorithm*)

arguments for GetNative

◆ PyCompositeAlgorithm_GetNative_RETURN

#define PyCompositeAlgorithm_GetNative_RETURN   CompositeAlgorithm_t*

return type for GetNative

◆ PyCompositeAlgorithm_New

#define PyCompositeAlgorithm_New    (*(PyCompositeAlgorithm_New_RETURN (*)PyCompositeAlgorithm_New_PROTO) PyCompositeAlgorithm_API[PyCompositeAlgorithm_New_NUM])

Creates a composite algorithm instance.

Release this object with Py_DECREF. If a CompositeAlgorithm_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 CompositeAlgorithm_t intance.
Returns
the PyCompositeAlgorithm instance.

◆ PyCompositeAlgorithm_New_NUM

#define PyCompositeAlgorithm_New_NUM   2

index of New

◆ PyCompositeAlgorithm_New_PROTO

#define PyCompositeAlgorithm_New_PROTO   (CompositeAlgorithm_t*)

arguments for New

◆ PyCompositeAlgorithm_New_RETURN

#define PyCompositeAlgorithm_New_RETURN   PyCompositeAlgorithm*

return type for New

◆ PyCompositeAlgorithm_Type_NUM

#define PyCompositeAlgorithm_Type_NUM   0

index of type