RAVE
pypolarnav.h File Reference

Python module for performing basic polar navigation. More...

#include "polarnav.h"

Go to the source code of this file.

Classes

struct  PyPolarNavigator
 A polar navigator. More...
 

Macros

#define PyPolarNavigator_Type_NUM   0
 index of type
 
#define PyPolarNavigator_GetNative_NUM   1
 index of GetNative
 
#define PyPolarNavigator_GetNative_RETURN   PolarNavigator_t*
 return type for GetNative
 
#define PyPolarNavigator_GetNative_PROTO   (PyPolarNavigator*)
 arguments for GetNative
 
#define PyPolarNavigator_New_NUM   2
 index of New
 
#define PyPolarNavigator_New_RETURN   PyPolarNavigator*
 return type for New
 
#define PyPolarNavigator_New_PROTO   (PolarNavigator_t*)
 arguments for New
 
#define PyPolarNavigator_API_pointers   3
 number of API pointers
 
#define PyPolarNavigator_CAPSULE_NAME   "_polarnav._C_API"
 
#define PyPolarNavigator_GetNative    (*(PyPolarNavigator_GetNative_RETURN (*)PyPolarNavigator_GetNative_PROTO) PyPolarNavigator_API[PyPolarNavigator_GetNative_NUM])
 Returns a pointer to the internal polar navigator, remember to release the reference when done with the object.
 
#define PyPolarNavigator_New    (*(PyPolarNavigator_New_RETURN (*)PyPolarNavigator_New_PROTO) PyPolarNavigator_API[PyPolarNavigator_New_NUM])
 Creates a new polar scan instance.
 
#define PyPolarNavigator_Check(op)
 Checks if the object is a python polar navigator.
 
#define PyPolarNavigator_Type   (*(PyTypeObject*)PyPolarNavigator_API[PyPolarNavigator_Type_NUM])
 
#define import_pypolarnav()
 Imports the PyArea module (like import _area in python).
 

Detailed Description

Python module for performing basic polar navigation.

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

Macro Definition Documentation

◆ import_pypolarnav

#define import_pypolarnav ( )
Value:
PyPolarNavigator_API = (void **)PyCapsule_Import(PyPolarNavigator_CAPSULE_NAME, 1);

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

◆ PyPolarNavigator_API_pointers

#define PyPolarNavigator_API_pointers   3

number of API pointers

◆ PyPolarNavigator_Check

#define PyPolarNavigator_Check ( op)
Value:
(Py_TYPE(op) == &PyPolarNavigator_Type)

Checks if the object is a python polar navigator.

◆ PyPolarNavigator_GetNative

#define PyPolarNavigator_GetNative    (*(PyPolarNavigator_GetNative_RETURN (*)PyPolarNavigator_GetNative_PROTO) PyPolarNavigator_API[PyPolarNavigator_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyPolarNavigator_GetNative_NUM

#define PyPolarNavigator_GetNative_NUM   1

index of GetNative

◆ PyPolarNavigator_GetNative_PROTO

#define PyPolarNavigator_GetNative_PROTO   (PyPolarNavigator*)

arguments for GetNative

◆ PyPolarNavigator_GetNative_RETURN

#define PyPolarNavigator_GetNative_RETURN   PolarNavigator_t*

return type for GetNative

◆ PyPolarNavigator_New

#define PyPolarNavigator_New    (*(PyPolarNavigator_New_RETURN (*)PyPolarNavigator_New_PROTO) PyPolarNavigator_API[PyPolarNavigator_New_NUM])

Creates a new polar scan instance.

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

Parameters
[in]polarnav- the PolarNavigator_t instance.
Returns
the PyPolarNavigator instance.

◆ PyPolarNavigator_New_NUM

#define PyPolarNavigator_New_NUM   2

index of New

◆ PyPolarNavigator_New_PROTO

#define PyPolarNavigator_New_PROTO   (PolarNavigator_t*)

arguments for New

◆ PyPolarNavigator_New_RETURN

#define PyPolarNavigator_New_RETURN   PyPolarNavigator*

return type for New

◆ PyPolarNavigator_Type_NUM

#define PyPolarNavigator_Type_NUM   0

index of type