Python version of the properties API. More...

#include "rave_properties.h"

Classes
struct	PyRaveProperties
	A cartesian product. More...

Macros
#define	PyRaveProperties_Type_NUM 0
	index of type

#define	PyRaveProperties_GetNative_NUM 1
	index of GetNative

#define	PyRaveProperties_GetNative_RETURN RaveProperties_t*
	return type for GetNative

#define	PyRaveProperties_GetNative_PROTO (PyRaveProperties*)
	arguments for GetNative

#define	PyRaveProperties_New_NUM 2
	index of New

#define	PyRaveProperties_New_RETURN PyRaveProperties*
	return type for New

#define	PyRaveProperties_New_PROTO (RaveProperties_t*)
	arguments for New

#define	PyRaveProperties_API_pointers 3
	number of API pointers

#define	PyRaveProperties_CAPSULE_NAME "_raveproperties._C_API"

#define	PyRaveProperties_GetNative ((PyRaveProperties_GetNative_RETURN ()PyRaveProperties_GetNative_PROTO) PyRaveProperties_API[PyRaveProperties_GetNative_NUM])
	Returns a pointer to the internal area, remember to release the reference when done with the object.

#define	PyRaveProperties_New ((PyRaveProperties_New_RETURN ()PyRaveProperties_New_PROTO) PyRaveProperties_API[PyRaveProperties_New_NUM])
	Creates a area registry instance.

#define	PyRaveProperties_Check(op)
	Loads a area registry instance.

#define	PyRaveProperties_Type ((PyTypeObject)PyRaveProperties_API[PyRaveProperties_Type_NUM])

#define	import_raveproperties()
	Imports the PyRaveProperties module (like import _arearegistry in python).

Detailed Description

Python version of the properties API.

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

Date: 2025-02-14

Macro Definition Documentation

◆ import_raveproperties

#define import_raveproperties ( )

Value:

PyRaveProperties_API = (void **)PyCapsule_Import(PyRaveProperties_CAPSULE_NAME, 1);

Imports the PyRaveProperties module (like import _arearegistry in python).

◆ PyRaveProperties_API_pointers

#define PyRaveProperties_API_pointers 3

number of API pointers

◆ PyRaveProperties_Check

#define PyRaveProperties_Check ( op )

Value:

(Py_TYPE(op) == &PyRaveProperties_Type)

Loads a area registry instance.

Release this object with Py_DECREF.

Parameters

[in]	filename	- the filename.
[in]	pyprojregistry	- the py projection registry

Returns: the PyRaveProperties instance. #define PyRaveProperties_Load \ (*(PyRaveProperties_Load_RETURN (*)PyRaveProperties_Load_PROTO) PyRaveProperties_API[PyRaveProperties_Load_NUM]) Checks if the object is a python area registry.

◆ PyRaveProperties_GetNative

#define PyRaveProperties_GetNative (*(PyRaveProperties_GetNative_RETURN (*)PyRaveProperties_GetNative_PROTO) PyRaveProperties_API[PyRaveProperties_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyRaveProperties_GetNative_NUM

#define PyRaveProperties_GetNative_NUM 1

index of GetNative

◆ PyRaveProperties_GetNative_PROTO

#define PyRaveProperties_GetNative_PROTO (PyRaveProperties*)

arguments for GetNative

◆ PyRaveProperties_GetNative_RETURN

#define PyRaveProperties_GetNative_RETURN RaveProperties_t*

return type for GetNative

◆ PyRaveProperties_New

#define PyRaveProperties_New (*(PyRaveProperties_New_RETURN (*)PyRaveProperties_New_PROTO) PyRaveProperties_API[PyRaveProperties_New_NUM])

Creates a area registry instance.

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

Parameters

[in] area - the Area_t intance.

Returns: the PyArea instance.

◆ PyRaveProperties_New_NUM

#define PyRaveProperties_New_NUM 2

index of New

◆ PyRaveProperties_New_PROTO

#define PyRaveProperties_New_PROTO (RaveProperties_t*)

arguments for New

◆ PyRaveProperties_New_RETURN

#define PyRaveProperties_New_RETURN PyRaveProperties*

return type for New

◆ PyRaveProperties_Type_NUM

#define PyRaveProperties_Type_NUM 0

index of type

Classes

Macros