pyarea.h File Reference

Python version of the Area API. More...

#include "area.h"

Go to the source code of this file.

Classes
struct	PyArea
	A cartesian product. More...

Macros
#define	PyArea_Type_NUM   0
	index of type
#define	PyArea_GetNative_NUM   1
	index of GetNative
#define	PyArea_GetNative_RETURN   Area_t*
	return type for GetNative
#define	PyArea_GetNative_PROTO   (PyArea*)
	arguments for GetNative
#define	PyArea_New_NUM   2
	index of New
#define	PyArea_New_RETURN   PyArea*
	return type for New
#define	PyArea_New_PROTO   (Area_t*)
	arguments for New
#define	PyArea_API_pointers   3
	number of API pointers
#define	PyArea_CAPSULE_NAME   "_area._C_API"
#define	PyArea_GetNative    (*(PyArea_GetNative_RETURN (*)PyArea_GetNative_PROTO) PyArea_API[PyArea_GetNative_NUM])
	Returns a pointer to the internal area, remember to release the reference when done with the object.
#define	PyArea_New    (*(PyArea_New_RETURN (*)PyArea_New_PROTO) PyArea_API[PyArea_New_NUM])
	Creates a new polar scan instance.
#define	PyArea_Check(op)
	Checks if the object is a python area.
#define	PyArea_Type   (*(PyTypeObject*)PyArea_API[PyArea_Type_NUM])
#define	import_pyarea()
	Imports the PyArea module (like import _area in python).

Detailed Description

Python version of the Area API.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2009-12-10

Macro Definition Documentation

import_pyarea

#define import_pyarea

(

)

Value:

    PyArea_API = (void **)PyCapsule_Import(PyArea_CAPSULE_NAME, 1);

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

PyArea_API_pointers

#define PyArea_API_pointers   3

number of API pointers

PyArea_Check

#define PyArea_Check

(

op

)

Value:

   (Py_TYPE(op) == &PyArea_Type)

Checks if the object is a python area.

PyArea_GetNative

#define PyArea_GetNative    (*(PyArea_GetNative_RETURN (*)PyArea_GetNative_PROTO) PyArea_API[PyArea_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

PyArea_GetNative_NUM

#define PyArea_GetNative_NUM   1

index of GetNative

PyArea_GetNative_PROTO

#define PyArea_GetNative_PROTO   (PyArea*)

arguments for GetNative

PyArea_GetNative_RETURN

#define PyArea_GetNative_RETURN   Area_t*

return type for GetNative

PyArea_New

#define PyArea_New    (*(PyArea_New_RETURN (*)PyArea_New_PROTO) PyArea_API[PyArea_New_NUM])

Creates a new polar scan instance.

Release this object with Py_DECREF. If a Area_t area is provided and this area 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.

PyArea_New_NUM

#define PyArea_New_NUM   2

index of New

PyArea_New_PROTO

#define PyArea_New_PROTO   (Area_t*)

arguments for New

PyArea_New_RETURN

#define PyArea_New_RETURN   PyArea*

return type for New

PyArea_Type_NUM

#define PyArea_Type_NUM   0

index of type