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

#include "compositearguments.h"

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

Macros
#define	PyCompositeArguments_Type_NUM 0
	index of type

#define	PyCompositeArguments_GetNative_NUM 1
	index of GetNative

#define	PyCompositeArguments_GetNative_RETURN CompositeArguments_t*
	return type for GetNative

#define	PyCompositeArguments_GetNative_PROTO (PyCompositeArguments*)
	arguments for GetNative

#define	PyCompositeArguments_New_NUM 2
	index of New

#define	PyCompositeArguments_New_RETURN PyCompositeArguments*
	return type for New

#define	PyCompositeArguments_New_PROTO (CompositeArguments_t*)
	arguments for New

#define	PyCompositeArguments_API_pointers 3
	number of api pointers

#define	PyCompositeArguments_CAPSULE_NAME "_compositearguments._C_API"

#define	PyCompositeArguments_GetNative ((PyCompositeArguments_GetNative_RETURN ()PyCompositeArguments_GetNative_PROTO) PyCompositeArguments_API[PyCompositeArguments_GetNative_NUM])
	Returns a pointer to the internal composite, remember to release the reference when done with the object.

#define	PyCompositeArguments_New ((PyCompositeArguments_New_RETURN ()PyCompositeArguments_New_PROTO) PyCompositeArguments_API[PyCompositeArguments_New_NUM])
	Creates a new composite generator instance.

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

#define	PyCompositeArguments_Type ((PyTypeObject)PyCompositeArguments_API[PyCompositeArguments_Type_NUM])

#define	import_compositearguments()
	Imports the PyCompositeArguments module (like import _compositearguments in python).

Detailed Description

Python version of the Composite Arguments API.

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

Date: 2024-12-13

Macro Definition Documentation

◆ import_compositearguments

#define import_compositearguments ( )

Value:

PyCompositeArguments_API = (void **)PyCapsule_Import(PyCompositeArguments_CAPSULE_NAME, 1);

Imports the PyCompositeArguments module (like import _compositearguments in python).

◆ PyCompositeArguments_API_pointers

#define PyCompositeArguments_API_pointers 3

number of api pointers

◆ PyCompositeArguments_Check

#define PyCompositeArguments_Check ( op )

Value:

(Py_TYPE(op) == &PyCompositeArguments_Type)

Checks if the object is a python composite.

◆ PyCompositeArguments_GetNative

#define PyCompositeArguments_GetNative (*(PyCompositeArguments_GetNative_RETURN (*)PyCompositeArguments_GetNative_PROTO) PyCompositeArguments_API[PyCompositeArguments_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyCompositeArguments_GetNative_NUM

#define PyCompositeArguments_GetNative_NUM 1

index of GetNative

◆ PyCompositeArguments_GetNative_PROTO

#define PyCompositeArguments_GetNative_PROTO (PyCompositeArguments*)

arguments for GetNative

◆ PyCompositeArguments_GetNative_RETURN

#define PyCompositeArguments_GetNative_RETURN CompositeArguments_t*

return type for GetNative

◆ PyCompositeArguments_New

#define PyCompositeArguments_New (*(PyCompositeArguments_New_RETURN (*)PyCompositeArguments_New_PROTO) PyCompositeArguments_API[PyCompositeArguments_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 PyCompositeArguments instance.

◆ PyCompositeArguments_New_NUM

#define PyCompositeArguments_New_NUM 2

index of New

◆ PyCompositeArguments_New_PROTO

#define PyCompositeArguments_New_PROTO (CompositeArguments_t*)

arguments for New

◆ PyCompositeArguments_New_RETURN

#define PyCompositeArguments_New_RETURN PyCompositeArguments*

return type for New

◆ PyCompositeArguments_Type_NUM

#define PyCompositeArguments_Type_NUM 0

index of type

Classes

Macros