pyacqva.h File Reference

Python version of the Acqva API. More...

#include "acqva.h"

Go to the source code of this file.

Classes
struct	PyAcqva
	A composite generator. More...

Macros
#define	PyAcqva_Type_NUM   0
	index of type
#define	PyAcqva_GetNative_NUM   1
	index of GetNative
#define	PyAcqva_GetNative_RETURN   Acqva_t*
	return type for GetNative
#define	PyAcqva_GetNative_PROTO   (PyAcqva*)
	arguments for GetNative
#define	PyAcqva_New_NUM   2
	index of New
#define	PyAcqva_New_RETURN   PyAcqva*
	return type for New
#define	PyAcqva_New_PROTO   (Acqva_t*)
	arguments for New
#define	PyAcqva_API_pointers   3
	number of api pointers
#define	PyAcqva_CAPSULE_NAME   "_pyacqva._C_API"
#define	PyAcqva_GetNative    (*(PyAcqva_GetNative_RETURN (*)PyAcqva_GetNative_PROTO) PyAcqva_API[PyAcqva_GetNative_NUM])
	Returns a pointer to the internal composite, remember to release the reference when done with the object.
#define	PyAcqva_New    (*(PyAcqva_New_RETURN (*)PyAcqva_New_PROTO) PyAcqva_API[PyAcqva_New_NUM])
	Creates a new acqva instance.
#define	PyAcqva_Check(op)
	Checks if the object is a python acqva.
#define	PyAcqva_Type   (*(PyTypeObject*)PyAcqva_API[PyAcqva_Type_NUM])
#define	import_pyacqva()
	Imports the PyAcqva module (like import _pyacqva in python).

Detailed Description

Python version of the Acqva API.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2024-01-18

Macro Definition Documentation

import_pyacqva

#define import_pyacqva

(

)

Value:

    PyAcqva_API = (void **)PyCapsule_Import(PyAcqva_CAPSULE_NAME, 1);

Imports the PyAcqva module (like import _pyacqva in python).

PyAcqva_API_pointers

#define PyAcqva_API_pointers   3

number of api pointers

PyAcqva_Check

#define PyAcqva_Check

(

op

)

Value:

   (Py_TYPE(op) == &PyAcqva_Type)

Checks if the object is a python acqva.

PyAcqva_GetNative

#define PyAcqva_GetNative    (*(PyAcqva_GetNative_RETURN (*)PyAcqva_GetNative_PROTO) PyAcqva_API[PyAcqva_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

PyAcqva_GetNative_NUM

#define PyAcqva_GetNative_NUM   1

index of GetNative

PyAcqva_GetNative_PROTO

#define PyAcqva_GetNative_PROTO   (PyAcqva*)

arguments for GetNative

PyAcqva_GetNative_RETURN

#define PyAcqva_GetNative_RETURN   Acqva_t*

return type for GetNative

PyAcqva_New

#define PyAcqva_New    (*(PyAcqva_New_RETURN (*)PyAcqva_New_PROTO) PyAcqva_API[PyAcqva_New_NUM])

Creates a new acqva instance.

Release this object with Py_DECREF. If a Acqva_t instance is provided and this instance already is bound to a python instance, this instance will be increfed and returned.

Parameters

[in]

acqva

- the Acqva_t intance.

Returns

the PyAcqva instance.

PyAcqva_New_NUM

#define PyAcqva_New_NUM   2

index of New

PyAcqva_New_PROTO

#define PyAcqva_New_PROTO   (Acqva_t*)

arguments for New

PyAcqva_New_RETURN

#define PyAcqva_New_RETURN   PyAcqva*

return type for New

PyAcqva_Type_NUM

#define PyAcqva_Type_NUM   0

index of type