Python version of the Compositing Generator Factory API. More...

#include "Python.h"
#include "compositegeneratorfactory.h"

Classes
struct	PyCompositeGeneratorFactory
	The poo composite algorithm instance. More...

Macros
#define	PyCompositeGeneratorFactory_Type_NUM 0
	index of type

#define	PyCompositeGeneratorFactory_GetNative_NUM 1
	index of GetNative

#define	PyCompositeGeneratorFactory_GetNative_RETURN CompositeGeneratorFactory_t*
	return type for GetNative

#define	PyCompositeGeneratorFactory_GetNative_PROTO (PyCompositeGeneratorFactory*)
	arguments for GetNative

#define	PyCompositeGeneratorFactory_New_NUM 2
	index of New

#define	PyCompositeGeneratorFactory_New_RETURN PyCompositeGeneratorFactory*
	return type for New

#define	PyCompositeGeneratorFactory_New_PROTO (CompositeGeneratorFactory_t*)
	arguments for New

#define	PyCompositeGeneratorFactory_API_pointers 3
	number of type and function pointers

#define	PyCompositeGeneratorFactory_CAPSULE_NAME "_compositegeneratorfactory._C_API"

#define	PyCompositeGeneratorFactory_GetNative ((PyCompositeGeneratorFactory_GetNative_RETURN ()PyCompositeGeneratorFactory_GetNative_PROTO) PyCompositeGeneratorFactory_API[PyCompositeGeneratorFactory_GetNative_NUM])
	Returns a pointer to the internal composite generator plugin, remember to release the reference when done with the object.

#define	PyCompositeGeneratorFactory_New ((PyCompositeGeneratorFactory_New_RETURN ()PyCompositeGeneratorFactory_New_PROTO) PyCompositeGeneratorFactory_API[PyCompositeGeneratorFactory_New_NUM])
	Creates a composite generator factory instance.

#define	PyCompositeGeneratorFactory_Check(op)
	Checks if the object is a python composite generator plugin.

#define	PyCompositeGeneratorFactory_Type ((PyTypeObject)PyCompositeGeneratorFactory_API[PyCompositeGeneratorFactory_Type_NUM])

#define	import_compositegeneratorfactory()
	Imports the PyCompositeGeneratorFactory module (like import _compositegeneratorfactory in python).

Detailed Description

Python version of the Compositing Generator Factory API.

Author: Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date: 2024-12-09

Macro Definition Documentation

◆ import_compositegeneratorfactory

#define import_compositegeneratorfactory ( )

Value:

PyCompositeGeneratorFactory_API = (void **)PyCapsule_Import(PyCompositeGeneratorFactory_CAPSULE_NAME, 1);

Imports the PyCompositeGeneratorFactory module (like import _compositegeneratorfactory in python).

◆ PyCompositeGeneratorFactory_API_pointers

#define PyCompositeGeneratorFactory_API_pointers 3

number of type and function pointers

◆ PyCompositeGeneratorFactory_Check

#define PyCompositeGeneratorFactory_Check ( op )

Value:

(Py_TYPE(op) == &PyCompositeGeneratorFactory_Type)

Checks if the object is a python composite generator plugin.

◆ PyCompositeGeneratorFactory_GetNative

#define PyCompositeGeneratorFactory_GetNative (*(PyCompositeGeneratorFactory_GetNative_RETURN (*)PyCompositeGeneratorFactory_GetNative_PROTO) PyCompositeGeneratorFactory_API[PyCompositeGeneratorFactory_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyCompositeGeneratorFactory_GetNative_NUM

#define PyCompositeGeneratorFactory_GetNative_NUM 1

index of GetNative

◆ PyCompositeGeneratorFactory_GetNative_PROTO

#define PyCompositeGeneratorFactory_GetNative_PROTO (PyCompositeGeneratorFactory*)

arguments for GetNative

◆ PyCompositeGeneratorFactory_GetNative_RETURN

#define PyCompositeGeneratorFactory_GetNative_RETURN CompositeGeneratorFactory_t*

return type for GetNative

◆ PyCompositeGeneratorFactory_New

#define PyCompositeGeneratorFactory_New (*(PyCompositeGeneratorFactory_New_RETURN (*)PyCompositeGeneratorFactory_New_PROTO) PyCompositeGeneratorFactory_API[PyCompositeGeneratorFactory_New_NUM])

Creates a composite generator factory instance.

Release this object with Py_DECREF. If a CompositeGeneratorFactory_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 CompositeGeneratorFactory_t intance.

Returns: the PyCompositeGeneratorFactory instance.

◆ PyCompositeGeneratorFactory_New_NUM

#define PyCompositeGeneratorFactory_New_NUM 2

index of New

◆ PyCompositeGeneratorFactory_New_PROTO

#define PyCompositeGeneratorFactory_New_PROTO (CompositeGeneratorFactory_t*)

arguments for New

◆ PyCompositeGeneratorFactory_New_RETURN

#define PyCompositeGeneratorFactory_New_RETURN PyCompositeGeneratorFactory*

return type for New

◆ PyCompositeGeneratorFactory_Type_NUM

#define PyCompositeGeneratorFactory_Type_NUM 0

index of type

Classes

Macros