RAVE
pyacqvafeaturemap.h File Reference

Python version of the AcqvaFeatureMap API. More...

#include "acqvafeaturemap.h"

Go to the source code of this file.

Classes

struct  PyAcqvaFeatureMap
 A feature map. More...
 
struct  PyAcqvaFeatureMapElevation
 
struct  PyAcqvaFeatureMapField
 

Macros

#define PyAcqvaFeatureMap_Type_NUM   0
 index of type
 
#define PyAcqvaFeatureMap_GetNative_NUM   1
 index of GetNative
 
#define PyAcqvaFeatureMap_GetNative_RETURN   AcqvaFeatureMap_t*
 return type for GetNative
 
#define PyAcqvaFeatureMap_GetNative_PROTO   (PyAcqvaFeatureMap*)
 arguments for GetNative
 
#define PyAcqvaFeatureMap_New_NUM   2
 index of New
 
#define PyAcqvaFeatureMap_New_RETURN   PyAcqvaFeatureMap*
 return type for New
 
#define PyAcqvaFeatureMap_New_PROTO   (AcqvaFeatureMap_t*)
 arguments for New
 
#define PyAcqvaFeatureMapElevation_Type_NUM   3
 index of elevation type
 
#define PyAcqvaFeatureMapElevation_GetNative_NUM   4
 index of GetNative
 
#define PyAcqvaFeatureMapElevation_GetNative_RETURN   AcqvaFeatureMapElevation_t*
 return type for GetNative
 
#define PyAcqvaFeatureMapElevation_GetNative_PROTO   (PyAcqvaFeatureMapElevation*)
 arguments for GetNative
 
#define PyAcqvaFeatureMapElevation_New_NUM   5
 index of elevation type
 
#define PyAcqvaFeatureMapElevation_New_RETURN   PyAcqvaFeatureMapElevation*
 return type for New
 
#define PyAcqvaFeatureMapElevation_New_PROTO   (AcqvaFeatureMapElevation_t*)
 arguments for New
 
#define PyAcqvaFeatureMapField_Type_NUM   6
 index of field type
 
#define PyAcqvaFeatureMapField_GetNative_NUM   7
 index of GetNative
 
#define PyAcqvaFeatureMapField_GetNative_RETURN   AcqvaFeatureMapField_t*
 return type for GetNative
 
#define PyAcqvaFeatureMapField_GetNative_PROTO   (PyAcqvaFeatureMapField*)
 arguments for GetNative
 
#define PyAcqvaFeatureMapField_New_NUM   8
 index of elevation type
 
#define PyAcqvaFeatureMapField_New_RETURN   PyAcqvaFeatureMapField*
 return type for GetNative
 
#define PyAcqvaFeatureMapField_New_PROTO   (AcqvaFeatureMapField_t*)
 arguments for GetNative
 
#define PyAcqvaFeatureMap_API_pointers   9
 number of API pointers
 
#define PyAcqvaFeatureMap_CAPSULE_NAME   "_acqvafeaturemap._C_API"
 
#define PyAcqvaFeatureMap_GetNative    (*(PyAcqvaFeatureMap_GetNative_RETURN (*)PyAcqvaFeatureMap_GetNative_PROTO) PyAcqvaFeatureMap_API[PyAcqvaFeatureMap_GetNative_NUM])
 Returns a pointer to the internal acqva feature map, remember to release the reference when done with the object.
 
#define PyAcqvaFeatureMap_New    (*(PyAcqvaFeatureMap_New_RETURN (*)PyAcqvaFeatureMap_New_PROTO) PyAcqvaFeatureMap_API[PyAcqvaFeatureMap_New_NUM])
 Creates a acqva feature map instance.
 
#define PyAcqvaFeatureMapElevation_GetNative    (*(PyAcqvaFeatureMapElevation_GetNative_RETURN (*)PyAcqvaFeatureMapElevation_GetNative_PROTO) PyAcqvaFeatureMapElevation_API[PyAcqvaFeatureMapElevation_GetNative_NUM])
 Returns a pointer to the internal acqva feature map elevation, remember to release the reference when done with the object.
 
#define PyAcqvaFeatureMapElevation_New    (*(PyAcqvaFeatureMapElevation_New_RETURN (*)PyAcqvaFeatureMapElevation_New_PROTO) PyAcqvaFeatureMapElevation_API[PyAcqvaFeatureMapElevation_New_NUM])
 Creates a new acqva feature map elevation.
 
#define PyAcqvaFeatureMapField_GetNative    (*(PyAcqvaFeatureMapField_GetNative_RETURN (*)PyAcqvaFeatureMapField_GetNative_PROTO) PyAcqvaFeatureMapField_API[PyAcqvaFeatureMapField_GetNative_NUM])
 Returns a pointer to the internal acqva feature map field, remember to release the reference when done with the object.
 
#define PyAcqvaFeatureMapField_New    (*(PyAcqvaFeatureMapField_New_RETURN (*)PyAcqvaFeatureMapField_New_PROTO) PyAcqvaFeatureMapField_API[PyAcqvaFeatureMapField_New_NUM])
 Creates a new acqva feature map field.
 
#define PyAcqvaFeatureMap_Check(op)
 Checks if the object is a python area.
 
#define PyAcqvaFeatureMapElevation_Check(op)
 
#define PyAcqvaFeatureMapField_Check(op)
 
#define PyAcqvaFeatureMap_Type   (*(PyTypeObject*)PyAcqvaFeatureMap_API[PyAcqvaFeatureMap_Type_NUM])
 
#define PyAcqvaFeatureMapElevation_Type   (*(PyTypeObject*)PyAcqvaFeatureMap_API[PyAcqvaFeatureMapElevation_Type_NUM])
 
#define PyAcqvaFeatureMapField_Type   (*(PyTypeObject*)PyAcqvaFeatureMap_API[PyAcqvaFeatureMapElevation_Type_NUM])
 
#define import_acqvafeaturemap()
 Imports the PyArea module (like import _area in python).
 

Detailed Description

Python version of the AcqvaFeatureMap API.

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

Macro Definition Documentation

◆ import_acqvafeaturemap

#define import_acqvafeaturemap ( )
Value:
PyAcqvaFeatureMap_API = (void **)PyCapsule_Import(PyAcqvaFeatureMap_CAPSULE_NAME, 1);

Imports the PyArea module (like import _area in python).

◆ PyAcqvaFeatureMap_API_pointers

#define PyAcqvaFeatureMap_API_pointers   9

number of API pointers

◆ PyAcqvaFeatureMap_Check

#define PyAcqvaFeatureMap_Check ( op)
Value:
(Py_TYPE(op) == &PyAcqvaFeatureMap_Type)

Checks if the object is a python area.

◆ PyAcqvaFeatureMap_GetNative

#define PyAcqvaFeatureMap_GetNative    (*(PyAcqvaFeatureMap_GetNative_RETURN (*)PyAcqvaFeatureMap_GetNative_PROTO) PyAcqvaFeatureMap_API[PyAcqvaFeatureMap_GetNative_NUM])

Returns a pointer to the internal acqva feature map, remember to release the reference when done with the object.

(RAVE_OBJECT_RELEASE).

◆ PyAcqvaFeatureMap_GetNative_NUM

#define PyAcqvaFeatureMap_GetNative_NUM   1

index of GetNative

◆ PyAcqvaFeatureMap_GetNative_PROTO

#define PyAcqvaFeatureMap_GetNative_PROTO   (PyAcqvaFeatureMap*)

arguments for GetNative

◆ PyAcqvaFeatureMap_GetNative_RETURN

#define PyAcqvaFeatureMap_GetNative_RETURN   AcqvaFeatureMap_t*

return type for GetNative

◆ PyAcqvaFeatureMap_New

#define PyAcqvaFeatureMap_New    (*(PyAcqvaFeatureMap_New_RETURN (*)PyAcqvaFeatureMap_New_PROTO) PyAcqvaFeatureMap_API[PyAcqvaFeatureMap_New_NUM])

Creates a acqva feature map instance.

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

Parameters
[in]obj- the AcqvaFeatureMap_t intance.
Returns
the PyAcqvaFeatureMap instance.

◆ PyAcqvaFeatureMap_New_NUM

#define PyAcqvaFeatureMap_New_NUM   2

index of New

◆ PyAcqvaFeatureMap_New_PROTO

#define PyAcqvaFeatureMap_New_PROTO   (AcqvaFeatureMap_t*)

arguments for New

◆ PyAcqvaFeatureMap_New_RETURN

#define PyAcqvaFeatureMap_New_RETURN   PyAcqvaFeatureMap*

return type for New

◆ PyAcqvaFeatureMap_Type_NUM

#define PyAcqvaFeatureMap_Type_NUM   0

index of type

◆ PyAcqvaFeatureMapElevation_Check

#define PyAcqvaFeatureMapElevation_Check ( op)
Value:
(Py_TYPE(op) == &PyAcqvaFeatureMapElevation_Type)

◆ PyAcqvaFeatureMapElevation_GetNative

#define PyAcqvaFeatureMapElevation_GetNative    (*(PyAcqvaFeatureMapElevation_GetNative_RETURN (*)PyAcqvaFeatureMapElevation_GetNative_PROTO) PyAcqvaFeatureMapElevation_API[PyAcqvaFeatureMapElevation_GetNative_NUM])

Returns a pointer to the internal acqva feature map elevation, remember to release the reference when done with the object.

(RAVE_OBJECT_RELEASE).

◆ PyAcqvaFeatureMapElevation_GetNative_NUM

#define PyAcqvaFeatureMapElevation_GetNative_NUM   4

index of GetNative

◆ PyAcqvaFeatureMapElevation_GetNative_PROTO

#define PyAcqvaFeatureMapElevation_GetNative_PROTO   (PyAcqvaFeatureMapElevation*)

arguments for GetNative

◆ PyAcqvaFeatureMapElevation_GetNative_RETURN

#define PyAcqvaFeatureMapElevation_GetNative_RETURN   AcqvaFeatureMapElevation_t*

return type for GetNative

◆ PyAcqvaFeatureMapElevation_New

#define PyAcqvaFeatureMapElevation_New    (*(PyAcqvaFeatureMapElevation_New_RETURN (*)PyAcqvaFeatureMapElevation_New_PROTO) PyAcqvaFeatureMapElevation_API[PyAcqvaFeatureMapElevation_New_NUM])

Creates a new acqva feature map elevation.

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

Parameters
[in]obj- the AcqvaFeatureMapElevation_t intance.
Returns
the PyAcqvaFeatureMapElevation instance.

◆ PyAcqvaFeatureMapElevation_New_NUM

#define PyAcqvaFeatureMapElevation_New_NUM   5

index of elevation type

◆ PyAcqvaFeatureMapElevation_New_PROTO

#define PyAcqvaFeatureMapElevation_New_PROTO   (AcqvaFeatureMapElevation_t*)

arguments for New

◆ PyAcqvaFeatureMapElevation_New_RETURN

#define PyAcqvaFeatureMapElevation_New_RETURN   PyAcqvaFeatureMapElevation*

return type for New

◆ PyAcqvaFeatureMapElevation_Type_NUM

#define PyAcqvaFeatureMapElevation_Type_NUM   3

index of elevation type

◆ PyAcqvaFeatureMapField_Check

#define PyAcqvaFeatureMapField_Check ( op)
Value:
(Py_TYPE(op) == &PyAcqvaFeatureMapField_Type)

◆ PyAcqvaFeatureMapField_GetNative

#define PyAcqvaFeatureMapField_GetNative    (*(PyAcqvaFeatureMapField_GetNative_RETURN (*)PyAcqvaFeatureMapField_GetNative_PROTO) PyAcqvaFeatureMapField_API[PyAcqvaFeatureMapField_GetNative_NUM])

Returns a pointer to the internal acqva feature map field, remember to release the reference when done with the object.

(RAVE_OBJECT_RELEASE).

◆ PyAcqvaFeatureMapField_GetNative_NUM

#define PyAcqvaFeatureMapField_GetNative_NUM   7

index of GetNative

◆ PyAcqvaFeatureMapField_GetNative_PROTO

#define PyAcqvaFeatureMapField_GetNative_PROTO   (PyAcqvaFeatureMapField*)

arguments for GetNative

◆ PyAcqvaFeatureMapField_GetNative_RETURN

#define PyAcqvaFeatureMapField_GetNative_RETURN   AcqvaFeatureMapField_t*

return type for GetNative

◆ PyAcqvaFeatureMapField_New

#define PyAcqvaFeatureMapField_New    (*(PyAcqvaFeatureMapField_New_RETURN (*)PyAcqvaFeatureMapField_New_PROTO) PyAcqvaFeatureMapField_API[PyAcqvaFeatureMapField_New_NUM])

Creates a new acqva feature map field.

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

Parameters
[in]obj- the AcqvaFeatureMapField_t intance.
Returns
the PyAcqvaFeatureMapField instance.

◆ PyAcqvaFeatureMapField_New_NUM

#define PyAcqvaFeatureMapField_New_NUM   8

index of elevation type

◆ PyAcqvaFeatureMapField_New_PROTO

#define PyAcqvaFeatureMapField_New_PROTO   (AcqvaFeatureMapField_t*)

arguments for GetNative

◆ PyAcqvaFeatureMapField_New_RETURN

#define PyAcqvaFeatureMapField_New_RETURN   PyAcqvaFeatureMapField*

return type for GetNative

◆ PyAcqvaFeatureMapField_Type_NUM

#define PyAcqvaFeatureMapField_Type_NUM   6

index of field type