RAVE
pyverticalprofile.h File Reference

Python version of the VerticalProfile API. More...

#include "vertical_profile.h"
#include <Python.h>

Go to the source code of this file.

Classes

struct  PyVerticalProfile
 A generic vertical profile. More...
 

Macros

#define PyVerticalProfile_Type_NUM   0
 index of the type
 
#define PyVerticalProfile_GetNative_NUM   1
 index of GetNative
 
#define PyVerticalProfile_GetNative_RETURN   VerticalProfile_t*
 return type for GetNative
 
#define PyVerticalProfile_GetNative_PROTO   (PyVerticalProfile*)
 arguments for GetNative
 
#define PyVerticalProfile_New_NUM   2
 index of New
 
#define PyVerticalProfile_New_RETURN   PyVerticalProfile*
 return type for New
 
#define PyVerticalProfile_New_PROTO   (VerticalProfile_t*)
 arguments for New
 
#define PyVerticalProfile_API_pointers   3
 number of pointers
 
#define PyVerticalProfile_CAPSULE_NAME   "_verticalprofile._C_API"
 
#define PyVerticalProfile_GetNative    (*(PyVerticalProfile_GetNative_RETURN (*)PyVerticalProfile_GetNative_PROTO) PyVerticalProfile_API[PyVerticalProfile_GetNative_NUM])
 Returns a pointer to the internal vertical profile, remember to release the reference when done with the object.
 
#define PyVerticalProfile_New    (*(PyVerticalProfile_New_RETURN (*)PyVerticalProfile_New_PROTO) PyVerticalProfile_API[PyVerticalProfile_New_NUM])
 Creates a new vertical profile instance.
 
#define PyVerticalProfile_Check(op)
 Checks if the object is a python polar scan .
 
#define PyVerticalProfile_Type   (*(PyTypeObject*)PyVerticalProfile_API[PyVerticalProfile_Type_NUM])
 
#define import_pyverticalprofile()
 Imports the PyVerticalProfile module (like import _verticalprofile in python).
 

Detailed Description

Python version of the VerticalProfile API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2012-08-24

Macro Definition Documentation

◆ import_pyverticalprofile

#define import_pyverticalprofile ( )
Value:
PyVerticalProfile_API = (void **)PyCapsule_Import(PyVerticalProfile_CAPSULE_NAME, 1);

Imports the PyVerticalProfile module (like import _verticalprofile in python).

◆ PyVerticalProfile_API_pointers

#define PyVerticalProfile_API_pointers   3

number of pointers

◆ PyVerticalProfile_Check

#define PyVerticalProfile_Check ( op)
Value:
(Py_TYPE(op) == &PyVerticalProfile_Type)

Checks if the object is a python polar scan .

◆ PyVerticalProfile_GetNative

#define PyVerticalProfile_GetNative    (*(PyVerticalProfile_GetNative_RETURN (*)PyVerticalProfile_GetNative_PROTO) PyVerticalProfile_API[PyVerticalProfile_GetNative_NUM])

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

(RAVE_OBJECT_RELEASE).

◆ PyVerticalProfile_GetNative_NUM

#define PyVerticalProfile_GetNative_NUM   1

index of GetNative

◆ PyVerticalProfile_GetNative_PROTO

#define PyVerticalProfile_GetNative_PROTO   (PyVerticalProfile*)

arguments for GetNative

◆ PyVerticalProfile_GetNative_RETURN

#define PyVerticalProfile_GetNative_RETURN   VerticalProfile_t*

return type for GetNative

◆ PyVerticalProfile_New

#define PyVerticalProfile_New    (*(PyVerticalProfile_New_RETURN (*)PyVerticalProfile_New_PROTO) PyVerticalProfile_API[PyVerticalProfile_New_NUM])

Creates a new vertical profile instance.

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

Parameters
[in]verticalprofile - the VerticalProfile_t intance.
Returns
the PyVerticalProfile instance.

◆ PyVerticalProfile_New_NUM

#define PyVerticalProfile_New_NUM   2

index of New

◆ PyVerticalProfile_New_PROTO

#define PyVerticalProfile_New_PROTO   (VerticalProfile_t*)

arguments for New

◆ PyVerticalProfile_New_RETURN

#define PyVerticalProfile_New_RETURN   PyVerticalProfile*

return type for New

◆ PyVerticalProfile_Type_NUM

#define PyVerticalProfile_Type_NUM   0

index of the type