RAVE
pyodimsources.h File Reference

Python version of the OdimSources API. More...

#include "odim_sources.h"

Go to the source code of this file.

Classes

struct  PyOdimSources
 A cartesian product. More...
 

Macros

#define PyOdimSources_Type_NUM   0
 index of type
 
#define PyOdimSources_GetNative_NUM   1
 index of GetNative
 
#define PyOdimSources_GetNative_RETURN   OdimSources_t*
 return type for GetNative
 
#define PyOdimSources_GetNative_PROTO   (PyOdimSources*)
 arguments for GetNative
 
#define PyOdimSources_New_NUM   2
 index of New
 
#define PyOdimSources_New_RETURN   PyOdimSources*
 return type for New
 
#define PyOdimSources_New_PROTO   (OdimSources_t*)
 arguments for New
 
#define PyOdimSources_Load_NUM   3
 index for Load
 
#define PyOdimSources_Load_RETURN   PyOdimSources*
 return type for Load
 
#define PyOdimSources_Load_PROTO   (const char* filename)
 argument prototype for Open
 
#define PyOdimSources_API_pointers   4
 number of API pointers
 
#define PyOdimSources_CAPSULE_NAME   "_odimsources._C_API"
 
#define PyOdimSources_GetNative    (*(PyOdimSources_GetNative_RETURN (*)PyOdimSources_GetNative_PROTO) PyOdimSources_API[PyOdimSources_GetNative_NUM])
 Returns a pointer to the internal odim sources, remember to release the reference when done with the object.
 
#define PyOdimSources_New    (*(PyOdimSources_New_RETURN (*)PyOdimSources_New_PROTO) PyOdimSources_API[PyOdimSources_New_NUM])
 Creates a odim sources instance.
 
#define PyOdimSources_Load    (*(PyOdimSources_Load_RETURN (*)PyOdimSources_Load_PROTO) PyOdimSources_API[PyOdimSources_Load_NUM])
 Loads a odim sources instance.
 
#define PyOdimSources_Check(op)
 Checks if the object is a python odim sources.
 
#define PyOdimSources_Type   (*(PyTypeObject*)PyOdimSources_API[PyOdimSources_Type_NUM])
 
#define import_odimsources()
 Imports the PyOdimSources module (like import _odimsources in python).
 

Detailed Description

Python version of the OdimSources API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2025-01-16

Macro Definition Documentation

◆ import_odimsources

#define import_odimsources ( )
Value:
PyOdimSources_API = (void **)PyCapsule_Import(PyOdimSources_CAPSULE_NAME, 1);

Imports the PyOdimSources module (like import _odimsources in python).

◆ PyOdimSources_API_pointers

#define PyOdimSources_API_pointers   4

number of API pointers

◆ PyOdimSources_Check

#define PyOdimSources_Check ( op)
Value:
(Py_TYPE(op) == &PyOdimSources_Type)

Checks if the object is a python odim sources.

◆ PyOdimSources_GetNative

#define PyOdimSources_GetNative    (*(PyOdimSources_GetNative_RETURN (*)PyOdimSources_GetNative_PROTO) PyOdimSources_API[PyOdimSources_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyOdimSources_GetNative_NUM

#define PyOdimSources_GetNative_NUM   1

index of GetNative

◆ PyOdimSources_GetNative_PROTO

#define PyOdimSources_GetNative_PROTO   (PyOdimSources*)

arguments for GetNative

◆ PyOdimSources_GetNative_RETURN

#define PyOdimSources_GetNative_RETURN   OdimSources_t*

return type for GetNative

◆ PyOdimSources_Load

#define PyOdimSources_Load    (*(PyOdimSources_Load_RETURN (*)PyOdimSources_Load_PROTO) PyOdimSources_API[PyOdimSources_Load_NUM])

Loads a odim sources instance.

Release this object with Py_DECREF.

Parameters
[in]filename- the filename.
Returns
the PyOdimSources instance.

◆ PyOdimSources_Load_NUM

#define PyOdimSources_Load_NUM   3

index for Load

◆ PyOdimSources_Load_PROTO

#define PyOdimSources_Load_PROTO   (const char* filename)

argument prototype for Open

◆ PyOdimSources_Load_RETURN

#define PyOdimSources_Load_RETURN   PyOdimSources*

return type for Load

◆ PyOdimSources_New

#define PyOdimSources_New    (*(PyOdimSources_New_RETURN (*)PyOdimSources_New_PROTO) PyOdimSources_API[PyOdimSources_New_NUM])

Creates a odim sources instance.

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

Parameters
[in]area- the OdimSources_t intance.
Returns
the PyOdimSources instance.

◆ PyOdimSources_New_NUM

#define PyOdimSources_New_NUM   2

index of New

◆ PyOdimSources_New_PROTO

#define PyOdimSources_New_PROTO   (OdimSources_t*)

arguments for New

◆ PyOdimSources_New_RETURN

#define PyOdimSources_New_RETURN   PyOdimSources*

return type for New

◆ PyOdimSources_Type_NUM

#define PyOdimSources_Type_NUM   0

index of type