pycomposite.h File Reference

Python version of the Composite API. More...

#include "composite.h"

Go to the source code of this file.

Classes
struct	PyComposite
	A composite generator. More...

Macros
#define	PyComposite_Type_NUM   0
	index of type
#define	PyComposite_GetNative_NUM   1
	index of GetNative
#define	PyComposite_GetNative_RETURN   Composite_t*
	return type for GetNative
#define	PyComposite_GetNative_PROTO   (PyComposite*)
	arguments for GetNative
#define	PyComposite_New_NUM   2
	index of New
#define	PyComposite_New_RETURN   PyComposite*
	return type for New
#define	PyComposite_New_PROTO   (Composite_t*)
	arguments for New
#define	PyComposite_API_pointers   3
	number of api pointers
#define	PyComposite_CAPSULE_NAME   "_pycomposite._C_API"
#define	PyComposite_GetNative    (*(PyComposite_GetNative_RETURN (*)PyComposite_GetNative_PROTO) PyComposite_API[PyComposite_GetNative_NUM])
	Returns a pointer to the internal composite, remember to release the reference when done with the object.
#define	PyComposite_New    (*(PyComposite_New_RETURN (*)PyComposite_New_PROTO) PyComposite_API[PyComposite_New_NUM])
	Creates a new composite instance.
#define	PyComposite_Check(op)
	Checks if the object is a python composite.
#define	PyComposite_Type   (*(PyTypeObject*)PyComposite_API[PyComposite_Type_NUM])
#define	import_pycomposite()
	Imports the PyArea module (like import _area in python).

Detailed Description

Python version of the Composite API.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2010-01-29

Macro Definition Documentation

import_pycomposite

#define import_pycomposite

(

)

Value:

    PyComposite_API = (void **)PyCapsule_Import(PyComposite_CAPSULE_NAME, 1);

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

PyComposite_API_pointers

#define PyComposite_API_pointers   3

number of api pointers

PyComposite_Check

#define PyComposite_Check

(

op

)

Value:

   (Py_TYPE(op) == &PyComposite_Type)

Checks if the object is a python composite.

PyComposite_GetNative

#define PyComposite_GetNative    (*(PyComposite_GetNative_RETURN (*)PyComposite_GetNative_PROTO) PyComposite_API[PyComposite_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

PyComposite_GetNative_NUM

#define PyComposite_GetNative_NUM   1

index of GetNative

PyComposite_GetNative_PROTO

#define PyComposite_GetNative_PROTO   (PyComposite*)

arguments for GetNative

PyComposite_GetNative_RETURN

#define PyComposite_GetNative_RETURN   Composite_t*

return type for GetNative

PyComposite_New

#define PyComposite_New    (*(PyComposite_New_RETURN (*)PyComposite_New_PROTO) PyComposite_API[PyComposite_New_NUM])

Creates a new composite instance.

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

Parameters

[in]

composite

- the Composite_t intance.

Returns

the PyComposite instance.

PyComposite_New_NUM

#define PyComposite_New_NUM   2

index of New

PyComposite_New_PROTO

#define PyComposite_New_PROTO   (Composite_t*)

arguments for New

PyComposite_New_RETURN

#define PyComposite_New_RETURN   PyComposite*

return type for New

PyComposite_Type_NUM

#define PyComposite_Type_NUM   0

index of type