pypolarscan.h File Reference

Python version of the PolarScan API. More...

#include "polarscan.h"

Go to the source code of this file.

Classes
struct	PyPolarScan
	A polar scan. More...

Macros
#define	PyPolarScan_Type_NUM   0
	index of the type
#define	PyPolarScan_GetNative_NUM   1
	index of GetNative
#define	PyPolarScan_GetNative_RETURN   PolarScan_t*
	return type for GetNative
#define	PyPolarScan_GetNative_PROTO   (PyPolarScan*)
	arguments for GetNative
#define	PyPolarScan_New_NUM   2
	index of New
#define	PyPolarScan_New_RETURN   PyPolarScan*
	return type for New
#define	PyPolarScan_New_PROTO   (PolarScan_t*)
	arguments for New
#define	PyPolarScan_API_pointers   3
	number of pointers
#define	PyPolarScan_CAPSULE_NAME   "_polarscan._C_API"
#define	PyPolarScan_GetNative    (*(PyPolarScan_GetNative_RETURN (*)PyPolarScan_GetNative_PROTO) PyPolarScan_API[PyPolarScan_GetNative_NUM])
	Returns a pointer to the internal polar scan, remember to release the reference when done with the object.
#define	PyPolarScan_New    (*(PyPolarScan_New_RETURN (*)PyPolarScan_New_PROTO) PyPolarScan_API[PyPolarScan_New_NUM])
	Creates a new polar scan instance.
#define	PyPolarScan_Check(op)
	Checks if the object is a python polar scan .
#define	PyPolarScan_Type   (*(PyTypeObject*)PyPolarScan_API[PyPolarScan_Type_NUM])
#define	import_pypolarscan()
	Imports the PyPolarScan module (like import _polarscan in python).

Detailed Description

Python version of the PolarScan API.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2009-12-08

Macro Definition Documentation

import_pypolarscan

#define import_pypolarscan

(

)

Value:

    PyPolarScan_API = (void **)PyCapsule_Import(PyPolarScan_CAPSULE_NAME, 1);

Imports the PyPolarScan module (like import _polarscan in python).

PyPolarScan_API_pointers

#define PyPolarScan_API_pointers   3

number of pointers

PyPolarScan_Check

#define PyPolarScan_Check

(

op

)

Value:

   (Py_TYPE(op) == &PyPolarScan_Type)

Checks if the object is a python polar scan .

PyPolarScan_GetNative

#define PyPolarScan_GetNative    (*(PyPolarScan_GetNative_RETURN (*)PyPolarScan_GetNative_PROTO) PyPolarScan_API[PyPolarScan_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

PyPolarScan_GetNative_NUM

#define PyPolarScan_GetNative_NUM   1

index of GetNative

PyPolarScan_GetNative_PROTO

#define PyPolarScan_GetNative_PROTO   (PyPolarScan*)

arguments for GetNative

PyPolarScan_GetNative_RETURN

#define PyPolarScan_GetNative_RETURN   PolarScan_t*

return type for GetNative

PyPolarScan_New

#define PyPolarScan_New    (*(PyPolarScan_New_RETURN (*)PyPolarScan_New_PROTO) PyPolarScan_API[PyPolarScan_New_NUM])

Creates a new polar scan instance.

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

Parameters

[in]

scan

- the PolarScan_t intance.

Returns

the PyPolarScan instance.

PyPolarScan_New_NUM

#define PyPolarScan_New_NUM   2

index of New

PyPolarScan_New_PROTO

#define PyPolarScan_New_PROTO   (PolarScan_t*)

arguments for New

PyPolarScan_New_RETURN

#define PyPolarScan_New_RETURN   PyPolarScan*

return type for New

PyPolarScan_Type_NUM

#define PyPolarScan_Type_NUM   0

index of the type