RAVE
pyarearegistry.h File Reference

Python version of the Area registry API. More...

#include "arearegistry.h"
#include "pyprojectionregistry.h"

Go to the source code of this file.

Classes

struct  PyAreaRegistry
 A cartesian product. More...
 

Macros

#define PyAreaRegistry_Type_NUM   0
 index of type
 
#define PyAreaRegistry_GetNative_NUM   1
 index of GetNative
 
#define PyAreaRegistry_GetNative_RETURN   AreaRegistry_t*
 return type for GetNative
 
#define PyAreaRegistry_GetNative_PROTO   (PyAreaRegistry*)
 arguments for GetNative
 
#define PyAreaRegistry_New_NUM   2
 index of New
 
#define PyAreaRegistry_New_RETURN   PyAreaRegistry*
 return type for New
 
#define PyAreaRegistry_New_PROTO   (AreaRegistry_t*)
 arguments for New
 
#define PyAreaRegistry_Load_NUM   3
 index for Load
 
#define PyAreaRegistry_Load_RETURN   PyAreaRegistry*
 return type for Load
 
#define PyAreaRegistry_Load_PROTO   (const char* filename, PyProjectionRegistry* pyprojregistry)
 argument prototype for Open
 
#define PyAreaRegistry_API_pointers   4
 number of API pointers
 
#define PyAreaRegistry_CAPSULE_NAME   "_area._C_API"
 
#define PyAreaRegistry_GetNative    (*(PyAreaRegistry_GetNative_RETURN (*)PyAreaRegistry_GetNative_PROTO) PyAreaRegistry_API[PyAreaRegistry_GetNative_NUM])
 Returns a pointer to the internal area, remember to release the reference when done with the object.
 
#define PyAreaRegistry_New    (*(PyAreaRegistry_New_RETURN (*)PyAreaRegistry_New_PROTO) PyAreaRegistry_API[PyAreaRegistry_New_NUM])
 Creates a area registry instance.
 
#define PyAreaRegistry_Load    (*(PyAreaRegistry_Load_RETURN (*)PyAreaRegistry_Load_PROTO) PyAreaRegistry_API[PyAreaRegistry_Load_NUM])
 Loads a area registry instance.
 
#define PyAreaRegistry_Check(op)
 Checks if the object is a python area registry.
 
#define PyAreaRegistry_Type   (*(PyTypeObject*)PyAreaRegistry_API[PyAreaRegistry_Type_NUM])
 
#define import_pyarearegistry()
 Imports the PyAreaRegistry module (like import _arearegistry in python).
 

Detailed Description

Python version of the Area registry API.

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

Macro Definition Documentation

◆ import_pyarearegistry

#define import_pyarearegistry ( )
Value:
PyAreaRegistry_API = (void **)PyCapsule_Import(PyAreaRegistry_CAPSULE_NAME, 1);

Imports the PyAreaRegistry module (like import _arearegistry in python).

◆ PyAreaRegistry_API_pointers

#define PyAreaRegistry_API_pointers   4

number of API pointers

◆ PyAreaRegistry_Check

#define PyAreaRegistry_Check ( op)
Value:
(Py_TYPE(op) == &PyAreaRegistry_Type)

Checks if the object is a python area registry.

◆ PyAreaRegistry_GetNative

#define PyAreaRegistry_GetNative    (*(PyAreaRegistry_GetNative_RETURN (*)PyAreaRegistry_GetNative_PROTO) PyAreaRegistry_API[PyAreaRegistry_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyAreaRegistry_GetNative_NUM

#define PyAreaRegistry_GetNative_NUM   1

index of GetNative

◆ PyAreaRegistry_GetNative_PROTO

#define PyAreaRegistry_GetNative_PROTO   (PyAreaRegistry*)

arguments for GetNative

◆ PyAreaRegistry_GetNative_RETURN

#define PyAreaRegistry_GetNative_RETURN   AreaRegistry_t*

return type for GetNative

◆ PyAreaRegistry_Load

#define PyAreaRegistry_Load    (*(PyAreaRegistry_Load_RETURN (*)PyAreaRegistry_Load_PROTO) PyAreaRegistry_API[PyAreaRegistry_Load_NUM])

Loads a area registry instance.

Release this object with Py_DECREF.

Parameters
[in]filename- the filename.
[in]pyprojregistry- the py projection registry
Returns
the PyAreaRegistry instance.

◆ PyAreaRegistry_Load_NUM

#define PyAreaRegistry_Load_NUM   3

index for Load

◆ PyAreaRegistry_Load_PROTO

#define PyAreaRegistry_Load_PROTO   (const char* filename, PyProjectionRegistry* pyprojregistry)

argument prototype for Open

◆ PyAreaRegistry_Load_RETURN

#define PyAreaRegistry_Load_RETURN   PyAreaRegistry*

return type for Load

◆ PyAreaRegistry_New

#define PyAreaRegistry_New    (*(PyAreaRegistry_New_RETURN (*)PyAreaRegistry_New_PROTO) PyAreaRegistry_API[PyAreaRegistry_New_NUM])

Creates a area registry instance.

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

◆ PyAreaRegistry_New_NUM

#define PyAreaRegistry_New_NUM   2

index of New

◆ PyAreaRegistry_New_PROTO

#define PyAreaRegistry_New_PROTO   (AreaRegistry_t*)

arguments for New

◆ PyAreaRegistry_New_RETURN

#define PyAreaRegistry_New_RETURN   PyAreaRegistry*

return type for New

◆ PyAreaRegistry_Type_NUM

#define PyAreaRegistry_Type_NUM   0

index of type