RAVE
pylazynodelistreader.h File Reference

Python version of the LazyNodeListReader API. More...

#include <lazy_nodelist_reader.h>

Go to the source code of this file.

Classes

struct  PyLazyNodeListReader
 The LazyNodeListReader. More...
 

Macros

#define PyLazyNodeListReader_Type_NUM   0
 index for Type
 
#define PyLazyNodeListReader_GetNative_NUM   1
 index for GetNative
 
#define PyLazyNodeListReader_GetNative_RETURN   LazyNodeListReader_t*
 return type for GetNative
 
#define PyLazyNodeListReader_GetNative_PROTO   (PyLazyNodeListReader*)
 argument prototype for GetNative
 
#define PyLazyNodeListReader_New_NUM   2
 index for New
 
#define PyLazyNodeListReader_New_RETURN   PyLazyNodeListReader*
 return type for New
 
#define PyLazyNodeListReader_New_PROTO   (LazyNodeListReader_t*)
 argument prototype for New
 
#define PyLazyNodeListReader_Read_NUM   3
 index for Read
 
#define PyLazyNodeListReader_Read_RETURN   PyLazyNodeListReader*
 return type for Read
 
#define PyLazyNodeListReader_Read_PROTO   (const char* filename)
 argument prototype for Read
 
#define PyLazyNodeListReader_API_pointers   4
 Total number of C API pointers.
 
#define PyLazyNodeListReader_CAPSULE_NAME   "_lazynodelistreader._C_API"
 
#define PyLazyNodeListReader_GetNative    (*(PyLazyNodeListReader_GetNative_RETURN (*)PyLazyNodeListReader_GetNative_PROTO) PyLazyNodeListReader_API[PyLazyNodeListReader_GetNative_NUM])
 Returns a pointer to the internal lazy nodelist io, remember to release the reference when done with the object.
 
#define PyLazyNodeListReader_New    (*(PyLazyNodeListReader_New_RETURN (*)PyLazyNodeListReader_New_PROTO) PyLazyNodeListReader_API[PyLazyNodeListReader_New_NUM])
 Creates a new lazy nodelist io instance.
 
#define PyLazyNodeListReader_Read    (*(PyLazyNodeListReader_Read_RETURN (*)PyLazyNodeListReader_Read_PROTO) PyLazyNodeListReader_API[PyLazyNodeListReader_Read_NUM])
 Read a file into a lazynodelistio instance.
 
#define PyLazyNodeListReader_Check(op)
 Checks if the object is a python rave io.
 
#define PyLazyNodeListReader_Type   (*(PyTypeObject*)PyLazyNodeListReader_API[PyLazyNodeListReader_Type_NUM])
 
#define import_pylazynodelistio()
 Imports the PyLazyNodeListReader module (like import _lazynodelistio in python).
 

Detailed Description

Python version of the LazyNodeListReader API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2020-11-06

Macro Definition Documentation

◆ import_pylazynodelistio

#define import_pylazynodelistio ( )
Value:
PyLazyNodeListReader_API = (void **)PyCapsule_Import(PyLazyNodeListReader_CAPSULE_NAME, 1);

Imports the PyLazyNodeListReader module (like import _lazynodelistio in python).

◆ PyLazyNodeListReader_API_pointers

#define PyLazyNodeListReader_API_pointers   4

Total number of C API pointers.

◆ PyLazyNodeListReader_Check

#define PyLazyNodeListReader_Check ( op)
Value:
(Py_TYPE(op) == &PyLazyNodeListReader_Type)

Checks if the object is a python rave io.

◆ PyLazyNodeListReader_GetNative

#define PyLazyNodeListReader_GetNative    (*(PyLazyNodeListReader_GetNative_RETURN (*)PyLazyNodeListReader_GetNative_PROTO) PyLazyNodeListReader_API[PyLazyNodeListReader_GetNative_NUM])

Returns a pointer to the internal lazy nodelist io, remember to release the reference when done with the object.

(RAVE_OBJECT_RELEASE).

◆ PyLazyNodeListReader_GetNative_NUM

#define PyLazyNodeListReader_GetNative_NUM   1

index for GetNative

◆ PyLazyNodeListReader_GetNative_PROTO

#define PyLazyNodeListReader_GetNative_PROTO   (PyLazyNodeListReader*)

argument prototype for GetNative

◆ PyLazyNodeListReader_GetNative_RETURN

#define PyLazyNodeListReader_GetNative_RETURN   LazyNodeListReader_t*

return type for GetNative

◆ PyLazyNodeListReader_New

#define PyLazyNodeListReader_New    (*(PyLazyNodeListReader_New_RETURN (*)PyLazyNodeListReader_New_PROTO) PyLazyNodeListReader_API[PyLazyNodeListReader_New_NUM])

Creates a new lazy nodelist io instance.

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

Parameters
[in]raveio- the LazyNodeListReader_t intance.
Returns
the PyLazyNodeListReader instance.

◆ PyLazyNodeListReader_New_NUM

#define PyLazyNodeListReader_New_NUM   2

index for New

◆ PyLazyNodeListReader_New_PROTO

#define PyLazyNodeListReader_New_PROTO   (LazyNodeListReader_t*)

argument prototype for New

◆ PyLazyNodeListReader_New_RETURN

#define PyLazyNodeListReader_New_RETURN   PyLazyNodeListReader*

return type for New

◆ PyLazyNodeListReader_Read

#define PyLazyNodeListReader_Read    (*(PyLazyNodeListReader_Read_RETURN (*)PyLazyNodeListReader_Read_PROTO) PyLazyNodeListReader_API[PyLazyNodeListReader_Read_NUM])

Read a file into a lazynodelistio instance.

Release this object with Py_DECREF.

Parameters
[in]filename- the filename.
Returns
the PyLazyNodeListReader instance.

◆ PyLazyNodeListReader_Read_NUM

#define PyLazyNodeListReader_Read_NUM   3

index for Read

◆ PyLazyNodeListReader_Read_PROTO

#define PyLazyNodeListReader_Read_PROTO   (const char* filename)

argument prototype for Read

◆ PyLazyNodeListReader_Read_RETURN

#define PyLazyNodeListReader_Read_RETURN   PyLazyNodeListReader*

return type for Read

◆ PyLazyNodeListReader_Type_NUM

#define PyLazyNodeListReader_Type_NUM   0

index for Type