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

#include "compositefilter.h"
#include <Python.h>

Classes
struct	PyCompositeFilter
	A composite argument structure. More...

Macros
#define	PyCompositeFilter_Type_NUM 0
	index of type

#define	PyCompositeFilter_GetNative_NUM 1
	index of GetNative

#define	PyCompositeFilter_GetNative_RETURN CompositeFilter_t*
	return type for GetNative

#define	PyCompositeFilter_GetNative_PROTO (PyCompositeFilter*)
	arguments for GetNative

#define	PyCompositeFilter_New_NUM 2
	index of New

#define	PyCompositeFilter_New_RETURN PyCompositeFilter*
	return type for New

#define	PyCompositeFilter_New_PROTO (CompositeFilter_t*)
	arguments for New

#define	PyCompositeFilter_API_pointers 3
	number of api pointers

#define	PyCompositeFilter_CAPSULE_NAME "_compositefilter._C_API"

#define	PyCompositeFilter_GetNative ((PyCompositeFilter_GetNative_RETURN ()PyCompositeFilter_GetNative_PROTO) PyCompositeFilter_API[PyCompositeFilter_GetNative_NUM])
	Returns a pointer to the internal composite, remember to release the reference when done with the object.

#define	PyCompositeFilter_New ((PyCompositeFilter_New_RETURN ()PyCompositeFilter_New_PROTO) PyCompositeFilter_API[PyCompositeFilter_New_NUM])
	Creates a new composite generator instance.

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

#define	PyCompositeFilter_Type ((PyTypeObject)PyCompositeFilter_API[PyCompositeFilter_Type_NUM])

#define	import_compositefilter()
	Imports the PyCompositeFilter module (like import _compositefilter in python).

Detailed Description

Python version of the Composite Filter API.

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

Date: 2025-01-27

Macro Definition Documentation

◆ import_compositefilter

#define import_compositefilter ( )

Value:

PyCompositeFilter_API = (void **)PyCapsule_Import(PyCompositeFilter_CAPSULE_NAME, 1);

Imports the PyCompositeFilter module (like import _compositefilter in python).

◆ PyCompositeFilter_API_pointers

#define PyCompositeFilter_API_pointers 3

number of api pointers

◆ PyCompositeFilter_Check

#define PyCompositeFilter_Check ( op )

Value:

(Py_TYPE(op) == &PyCompositeFilter_Type)

Checks if the object is a python composite.

◆ PyCompositeFilter_GetNative

#define PyCompositeFilter_GetNative (*(PyCompositeFilter_GetNative_RETURN (*)PyCompositeFilter_GetNative_PROTO) PyCompositeFilter_API[PyCompositeFilter_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyCompositeFilter_GetNative_NUM

#define PyCompositeFilter_GetNative_NUM 1

index of GetNative

◆ PyCompositeFilter_GetNative_PROTO

#define PyCompositeFilter_GetNative_PROTO (PyCompositeFilter*)

arguments for GetNative

◆ PyCompositeFilter_GetNative_RETURN

#define PyCompositeFilter_GetNative_RETURN CompositeFilter_t*

return type for GetNative

◆ PyCompositeFilter_New

#define PyCompositeFilter_New (*(PyCompositeFilter_New_RETURN (*)PyCompositeFilter_New_PROTO) PyCompositeFilter_API[PyCompositeFilter_New_NUM])

Creates a new composite generator instance.

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

Returns: the PyCompositeFilter instance.

◆ PyCompositeFilter_New_NUM

#define PyCompositeFilter_New_NUM 2

index of New

◆ PyCompositeFilter_New_PROTO

#define PyCompositeFilter_New_PROTO (CompositeFilter_t*)

arguments for New

◆ PyCompositeFilter_New_RETURN

#define PyCompositeFilter_New_RETURN PyCompositeFilter*

return type for New

◆ PyCompositeFilter_Type_NUM

#define PyCompositeFilter_Type_NUM 0

index of type

Classes

Macros