pycompositefactorymanager.h File Reference

Python version of the Composite Factory Manager API. More...

#include "compositefactorymanager.h"

Go to the source code of this file.

Classes
struct	PyCompositeFactoryManager
	A composite generator. More...

Macros
#define	PyCompositeFactoryManager_Type_NUM   0
	index of type
#define	PyCompositeFactoryManager_GetNative_NUM   1
	index of GetNative
#define	PyCompositeFactoryManager_GetNative_RETURN   CompositeFactoryManager_t*
	return type for GetNative
#define	PyCompositeFactoryManager_GetNative_PROTO   (PyCompositeFactoryManager*)
	arguments for GetNative
#define	PyCompositeFactoryManager_New_NUM   2
	index of New
#define	PyCompositeFactoryManager_New_RETURN   PyCompositeFactoryManager*
	return type for New
#define	PyCompositeFactoryManager_New_PROTO   (CompositeFactoryManager_t*)
	arguments for New
#define	PyCompositeFactoryManager_API_pointers   3
	number of api pointers
#define	PyCompositeFactoryManager_CAPSULE_NAME   "_compositefactorymanager._C_API"
#define	PyCompositeFactoryManager_GetNative    (*(PyCompositeFactoryManager_GetNative_RETURN (*)PyCompositeFactoryManager_GetNative_PROTO) PyCompositeFactoryManager_API[PyCompositeFactoryManager_GetNative_NUM])
	Returns a pointer to the internal composite, remember to release the reference when done with the object.
#define	PyCompositeFactoryManager_New    (*(PyCompositeFactoryManager_New_RETURN (*)PyCompositeFactoryManager_New_PROTO) PyCompositeFactoryManager_API[PyCompositeFactoryManager_New_NUM])
	Creates a new composite generator instance.
#define	PyCompositeFactoryManager_Check(op)
	Checks if the object is a python composite.
#define	PyCompositeFactoryManager_Type   (*(PyTypeObject*)PyCompositeFactoryManager_API[PyCompositeFactoryManager_Type_NUM])
#define	import_compositefactorymanager()
	Imports the PyCompositeFactoryManager module (like import _compositefactorymanager in python).

Detailed Description

Python version of the Composite Factory Manager API.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2025-01-30

Macro Definition Documentation

import_compositefactorymanager

#define import_compositefactorymanager

(

)

Value:

    PyCompositeFactoryManager_API = (void **)PyCapsule_Import(PyCompositeFactoryManager_CAPSULE_NAME, 0);

Imports the PyCompositeFactoryManager module (like import _compositefactorymanager in python).

PyCompositeFactoryManager_API_pointers

#define PyCompositeFactoryManager_API_pointers   3

number of api pointers

PyCompositeFactoryManager_Check

#define PyCompositeFactoryManager_Check

(

op

)

Value:

   (Py_TYPE(op) == &PyCompositeFactoryManager_Type)

Checks if the object is a python composite.

PyCompositeFactoryManager_GetNative

#define PyCompositeFactoryManager_GetNative    (*(PyCompositeFactoryManager_GetNative_RETURN (*)PyCompositeFactoryManager_GetNative_PROTO) PyCompositeFactoryManager_API[PyCompositeFactoryManager_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

PyCompositeFactoryManager_GetNative_NUM

#define PyCompositeFactoryManager_GetNative_NUM   1

index of GetNative

PyCompositeFactoryManager_GetNative_PROTO

#define PyCompositeFactoryManager_GetNative_PROTO   (PyCompositeFactoryManager*)

arguments for GetNative

PyCompositeFactoryManager_GetNative_RETURN

#define PyCompositeFactoryManager_GetNative_RETURN   CompositeFactoryManager_t*

return type for GetNative

PyCompositeFactoryManager_New

#define PyCompositeFactoryManager_New    (*(PyCompositeFactoryManager_New_RETURN (*)PyCompositeFactoryManager_New_PROTO) PyCompositeFactoryManager_API[PyCompositeFactoryManager_New_NUM])

Creates a new composite generator instance.

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

Returns

the PyCompositeFactoryManager instance.

PyCompositeFactoryManager_New_NUM

#define PyCompositeFactoryManager_New_NUM   2

index of New

PyCompositeFactoryManager_New_PROTO

#define PyCompositeFactoryManager_New_PROTO   (CompositeFactoryManager_t*)

arguments for New

PyCompositeFactoryManager_New_RETURN

#define PyCompositeFactoryManager_New_RETURN   PyCompositeFactoryManager*

return type for New

PyCompositeFactoryManager_Type_NUM

#define PyCompositeFactoryManager_Type_NUM   0

index of type