RAVE
pypolarscanparam.h File Reference

Python version of the PolarScanParam API. More...

#include "polarscanparam.h"

Go to the source code of this file.

Classes

struct  PyPolarScanParam
 A polar scan param. More...
 

Macros

#define PyPolarScanParam_Type_NUM   0
 index of the type
 
#define PyPolarScanParam_GetNative_NUM   1
 index of GetNative
 
#define PyPolarScanParam_GetNative_RETURN   PolarScanParam_t*
 return type for GetNative
 
#define PyPolarScanParam_GetNative_PROTO   (PyPolarScanParam*)
 arguments for GetNative
 
#define PyPolarScanParam_New_NUM   2
 index of New
 
#define PyPolarScanParam_New_RETURN   PyPolarScanParam*
 return type for New
 
#define PyPolarScanParam_New_PROTO   (PolarScanParam_t*)
 arguments for New
 
#define PyPolarScanParam_API_pointers   3
 number of pointers
 
#define PyPolarScanParam_CAPSULE_NAME   "_polarscanparam._C_API"
 
#define PyPolarScanParam_GetNative    (*(PyPolarScanParam_GetNative_RETURN (*)PyPolarScanParam_GetNative_PROTO) PyPolarScanParam_API[PyPolarScanParam_GetNative_NUM])
 Returns a pointer to the internal polar scan param, remember to release the reference when done with the object.
 
#define PyPolarScanParam_New    (*(PyPolarScanParam_New_RETURN (*)PyPolarScanParam_New_PROTO) PyPolarScanParam_API[PyPolarScanParam_New_NUM])
 Creates a new polar scan param instance.
 
#define PyPolarScanParam_Check(op)
 Checks if the object is a python polar scan param.
 
#define PyPolarScanParam_Type   (*(PyTypeObject*)PyPolarScanParam_API[PyPolarScanParam_Type_NUM])
 
#define import_pypolarscanparam()
 Imports the PyPolarScanParam module (like import _polarscanparam in python).
 

Detailed Description

Python version of the PolarScanParam API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2010-01-22

Macro Definition Documentation

◆ import_pypolarscanparam

#define import_pypolarscanparam ( )
Value:
PyPolarScanParam_API = (void **)PyCapsule_Import(PyPolarScanParam_CAPSULE_NAME, 1);

Imports the PyPolarScanParam module (like import _polarscanparam in python).

◆ PyPolarScanParam_API_pointers

#define PyPolarScanParam_API_pointers   3

number of pointers

◆ PyPolarScanParam_Check

#define PyPolarScanParam_Check ( op)
Value:
(Py_TYPE(op) == &PyPolarScanParam_Type)

Checks if the object is a python polar scan param.

◆ PyPolarScanParam_GetNative

#define PyPolarScanParam_GetNative    (*(PyPolarScanParam_GetNative_RETURN (*)PyPolarScanParam_GetNative_PROTO) PyPolarScanParam_API[PyPolarScanParam_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyPolarScanParam_GetNative_NUM

#define PyPolarScanParam_GetNative_NUM   1

index of GetNative

◆ PyPolarScanParam_GetNative_PROTO

#define PyPolarScanParam_GetNative_PROTO   (PyPolarScanParam*)

arguments for GetNative

◆ PyPolarScanParam_GetNative_RETURN

#define PyPolarScanParam_GetNative_RETURN   PolarScanParam_t*

return type for GetNative

◆ PyPolarScanParam_New

#define PyPolarScanParam_New    (*(PyPolarScanParam_New_RETURN (*)PyPolarScanParam_New_PROTO) PyPolarScanParam_API[PyPolarScanParam_New_NUM])

Creates a new polar scan param instance.

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

Parameters
[in]scan- the PolarScanParam_t intance.
Returns
the PyPolarScanParam instance.

◆ PyPolarScanParam_New_NUM

#define PyPolarScanParam_New_NUM   2

index of New

◆ PyPolarScanParam_New_PROTO

#define PyPolarScanParam_New_PROTO   (PolarScanParam_t*)

arguments for New

◆ PyPolarScanParam_New_RETURN

#define PyPolarScanParam_New_RETURN   PyPolarScanParam*

return type for New

◆ PyPolarScanParam_Type_NUM

#define PyPolarScanParam_Type_NUM   0

index of the type