Python version of the Composite Generator API. More...

#include "compositegenerator.h"

Classes
struct	PyCompositeGenerator
	A composite generator. More...

Macros
#define	PyCompositeGenerator_Type_NUM 0
	index of type

#define	PyCompositeGenerator_GetNative_NUM 1
	index of GetNative

#define	PyCompositeGenerator_GetNative_RETURN CompositeGenerator_t*
	return type for GetNative

#define	PyCompositeGenerator_GetNative_PROTO (PyCompositeGenerator*)
	arguments for GetNative

#define	PyCompositeGenerator_New_NUM 2
	index of New

#define	PyCompositeGenerator_New_RETURN PyCompositeGenerator*
	return type for New

#define	PyCompositeGenerator_New_PROTO (CompositeGenerator_t*)
	arguments for New

#define	PyCompositeGenerator_API_pointers 3
	number of api pointers

#define	PyCompositeGenerator_CAPSULE_NAME "_compositegenerator._C_API"

#define	PyCompositeGenerator_GetNative ((PyCompositeGenerator_GetNative_RETURN ()PyCompositeGenerator_GetNative_PROTO) PyCompositeGenerator_API[PyCompositeGenerator_GetNative_NUM])
	Returns a pointer to the internal composite, remember to release the reference when done with the object.

#define	PyCompositeGenerator_New ((PyCompositeGenerator_New_RETURN ()PyCompositeGenerator_New_PROTO) PyCompositeGenerator_API[PyCompositeGenerator_New_NUM])
	Creates a new composite generator instance.

#define	PyCompositeGenerator_Check(op)
	Checks if the object is a python composite.

#define	PyCompositeGenerator_Type ((PyTypeObject)PyCompositeGenerator_API[PyCompositeGenerator_Type_NUM])

#define	import_compositegenerator()
	Imports the PyCompositeGenerator module (like import _compositegenerator in python).

Detailed Description

Python version of the Composite Generator API.

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

Date: 2024-12-05

Macro Definition Documentation

◆ import_compositegenerator

#define import_compositegenerator ( )

Value:

PyCompositeGenerator_API = (void **)PyCapsule_Import(PyCompositeGenerator_CAPSULE_NAME, 0);

Imports the PyCompositeGenerator module (like import _compositegenerator in python).

◆ PyCompositeGenerator_API_pointers

#define PyCompositeGenerator_API_pointers 3

number of api pointers

◆ PyCompositeGenerator_Check

#define PyCompositeGenerator_Check ( op )

Value:

(Py_TYPE(op) == &PyCompositeGenerator_Type)

Checks if the object is a python composite.

◆ PyCompositeGenerator_GetNative

#define PyCompositeGenerator_GetNative (*(PyCompositeGenerator_GetNative_RETURN (*)PyCompositeGenerator_GetNative_PROTO) PyCompositeGenerator_API[PyCompositeGenerator_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyCompositeGenerator_GetNative_NUM

#define PyCompositeGenerator_GetNative_NUM 1

index of GetNative

◆ PyCompositeGenerator_GetNative_PROTO

#define PyCompositeGenerator_GetNative_PROTO (PyCompositeGenerator*)

arguments for GetNative

◆ PyCompositeGenerator_GetNative_RETURN

#define PyCompositeGenerator_GetNative_RETURN CompositeGenerator_t*

return type for GetNative

◆ PyCompositeGenerator_New

#define PyCompositeGenerator_New (*(PyCompositeGenerator_New_RETURN (*)PyCompositeGenerator_New_PROTO) PyCompositeGenerator_API[PyCompositeGenerator_New_NUM])

Creates a new composite generator instance.

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

Returns: the PyCompositeGenerator instance.

◆ PyCompositeGenerator_New_NUM

#define PyCompositeGenerator_New_NUM 2

index of New

◆ PyCompositeGenerator_New_PROTO

#define PyCompositeGenerator_New_PROTO (CompositeGenerator_t*)

arguments for New

◆ PyCompositeGenerator_New_RETURN

#define PyCompositeGenerator_New_RETURN PyCompositeGenerator*

return type for New

◆ PyCompositeGenerator_Type_NUM

#define PyCompositeGenerator_Type_NUM 0

index of type

Classes

Macros