Library of Assembled Shared Sources
 
Loading...
Searching...
No Matches
Module Function Macros

Detailed Description

These macros export C++ functions to a Python and add them to a Python module.

All macros take a ModuleDefinition as first argument.

Note
For stubgen to work correctly, these macros should be called in the same translation unit (source file) that declares the module with PY_DECLARE_MODULE_NAME_DOC or similar.

There are two sets of macros:

Macros

#define PY_MODULE_PY_FUNCTION_EX(i_module, f_cppFunction, s_functionName, s_doc)
 Export a C++ function to Python without automatic wrapper generation (deprecated)
 

Simple Function Export Macros

These macros export C++ functions to Python with automatic type deduction and wrapper generation.

Use these for simple function exports where overloading is not an issue and automatic type deduction is sufficient.

The basic form is:

PY_MODULE_FUNCTION( i_module, f_cppFunction )
#define PY_MODULE_FUNCTION(i_module, f_cppFunction)
Export a C++ function to Python.

with:

  • i_module : Module identifier declared by PY_DECLARE_MODULE_*
  • f_cppFunction : C++ function to export
Example
void spam(int a);
PY_MODULE_FUNCTION(foo, spam) // foo.spam(42)
#define PY_DECLARE_MODULE(i_module)
Declare a module with minimal setup (name derived from identifier, no documentation).
Common suffixes

The _NAME, _DOC and _EX suffixes allow you to specify a custom Python name, docstring, or (in rare cases) a custom dispatcher name.

Macro Adds parameters Use for ...
PY_MODULE_FUNCTION_NAME s_name Custom Python name
PY_MODULE_FUNCTION_DOC s_doc With docstring
PY_MODULE_FUNCTION_NAME_DOC s_name, s_doc Custom Python name + Docstring
PY_MODULE_FUNCTION_EX s_name, s_doc, i_dispatcher Custom dispatcher name
Example
void spam(int a);
PY_MODULE_FUNCTION (foo, spam) // foo.spam
PY_MODULE_FUNCTION_DOC (foo, spam, "eat it") // foo.spam, documented
PY_MODULE_FUNCTION_NAME (foo, spam, "eggs") // foo.eggs
PY_MODULE_FUNCTION_NAME_DOC(foo, spam, "eggs", "eat it") // foo.eggs, documented
PY_MODULE_FUNCTION_EX (foo, spam, "eggs", "eat it", dsp) // ... + explicit dispatcher
#define PY_MODULE_FUNCTION_NAME_DOC(i_module, f_cppFunction, s_name, s_doc)
Export a C++ function to Python, with custom name and docstring.
#define PY_MODULE_FUNCTION_NAME(i_module, f_cppFunction, s_name)
Export a C++ function to Python, with custom Python name.
#define PY_MODULE_FUNCTION_EX(i_module, f_cppFunction, s_functionName, s_doc, i_dispatcher)
Export a C++ function to Python, with full control.
#define PY_MODULE_FUNCTION_DOC(i_module, f_cppFunction, s_doc)
Export a C++ function to Python, with docstring.
Overloading Python functions

Multiple C++ functions can be exported to the same Python name, to create a Python function that is overloaded on the parameter types.

Note
Overload resolution uses first-fit, not best-fit like C++. The first exported overload that matches the arguments will be called.
Example
void barA(int a);
void barB(const std::string& b);
PY_MODULE_FUNCTION_NAME(foo, barA, "bar") // foo.bar(123)
PY_MODULE_FUNCTION_NAME(foo, barB, "bar") // foo.bar("123")
#define PY_MODULE_FUNCTION_EX(i_module, f_cppFunction, s_functionName, s_doc, i_dispatcher)
 Export a C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_NAME_DOC(i_module, f_cppFunction, s_name, s_doc)
 Export a C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_NAME(i_module, f_cppFunction, s_name)
 Export a C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_DOC(i_module, f_cppFunction, s_doc)
 Export a C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION(i_module, f_cppFunction)
 Export a C++ function to Python.
 

Qualified Free Functions

If the C++ function that you want to export is overloaded, then you need to be able to disambiquate what function exactly you want to export.

These macros export C++ functions to Python with explicit type qualification to resolve function overload ambiguities. They provide fine-grained control over function signatures to disambiguate overloaded functions, by adding the return type (except for constructors) and all parameter types.

The list of parameter types can be passed as a single lass::meta::TypeTuple, or as individual arguments. For the latter, the _<N> tells the number of arguments. The _<N> form is the most often used one, and simply packs its types into a TypeTuple

Form Adds parameters
PY_MODULE_FUNCTION_QUALIFIED t_return, t_params as lass::meta::TypeTuple
PY_MODULE_FUNCTION_QUALIFIED_<N> t_return, t_P1, t_P2, ... `t_P<N>
Example
double spam(int a, float b);
void spam(const std::string& c);
PY_MODULE_FUNCTION_QUALIFIED_2(foo, spam, double, int, float) // foo.spam(2, 3.14)
PY_MODULE_FUNCTION_QUALIFIED_1(foo, spam, void, const std::string&) // foo.spam("baz")
#define PY_MODULE_FUNCTION_QUALIFIED_1(i_module, f_cppFunction, t_return, t_P1)
Export an overloaded 1-ary C++ function to Python.
#define PY_MODULE_FUNCTION_QUALIFIED_2(i_module, f_cppFunction, t_return, t_P1, t_P2)
Export an overloaded 2-ary C++ function to Python.

They combine with the _NAME and _DOC suffixes, with the s_name, s_doc, i_dispatcher arguments following the function return and parameter types.

Example
void spam(const std::vector<int>& x);
double do_spam(int a, float b);
void do_spam(const std::string& c);
PY_MODULE_FUNCTION_DOC(foo, spam, "Does Spam!!!") // foo.spam([1,2,3])
PY_MODULE_FUNCTION_QUALIFIED_NAME_2(foo, do_spam, double, int, float, "spam") // foo.spam(2, 3.14)
PY_MODULE_FUNCTION_QUALIFIED_NAME_1(foo, do_spam, void, const std::string&, "spam") // foo.spam("baz")
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_1(i_module, f_cppFunction, t_return, t_P1, s_functionName)
Export an overloaded 1-ary C++ function to Python, with custom Python name.
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName)
Export an overloaded 2-ary C++ function to Python, with custom Python name.
#define PY_MODULE_FUNCTION_QUALIFIED_EX(i_module, f_cppFunction, t_return, t_params, s_functionName, s_doc, i_dispatcher)
 Export an overloaded C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_0(i_module, f_cppFunction, t_return, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 0-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_1(i_module, f_cppFunction, t_return, t_P1, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 1-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 2-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 3-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 4-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 5-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 6-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 7-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 8-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 9-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 10-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 11-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 12-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 13-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 14-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_EX_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName, s_doc, i_dispatcher)
 Export an overloaded 15-ary C++ function to Python, with full control.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC(i_module, f_cppFunction, t_return, t_params, s_functionName, s_doc)
 Export an overloaded C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_0(i_module, f_cppFunction, t_return, t_params, s_functionName, s_doc)
 Export an overloaded 0-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_1(i_module, f_cppFunction, t_return, t_P1, s_functionName, s_doc)
 Export an overloaded 1-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName, s_doc)
 Export an overloaded 2-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName, s_doc)
 Export an overloaded 3-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName, s_doc)
 Export an overloaded 4-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName, s_doc)
 Export an overloaded 5-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName, s_doc)
 Export an overloaded 6-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName, s_doc)
 Export an overloaded 7-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName, s_doc)
 Export an overloaded 8-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName, s_doc)
 Export an overloaded 9-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName, s_doc)
 Export an overloaded 10-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName, s_doc)
 Export an overloaded 11-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName, s_doc)
 Export an overloaded 12-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName, s_doc)
 Export an overloaded 13-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName, s_doc)
 Export an overloaded 14-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName, s_doc)
 Export an overloaded 15-ary C++ function to Python, with custom name and docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME(i_module, f_cppFunction, t_return, t_params, s_functionName)
 Export an overloaded C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_0(i_module, f_cppFunction, t_return, s_functionName)
 Export an overloaded 0-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_1(i_module, f_cppFunction, t_return, t_P1, s_functionName)
 Export an overloaded 1-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName)
 Export an overloaded 2-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName)
 Export an overloaded 3-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName)
 Export an overloaded 4-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName)
 Export an overloaded 5-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName)
 Export an overloaded 6-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName)
 Export an overloaded 7-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName)
 Export an overloaded 8-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName)
 Export an overloaded 9-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName)
 Export an overloaded 10-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName)
 Export an overloaded 11-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName)
 Export an overloaded 12-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName)
 Export an overloaded 13-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName)
 Export an overloaded 14-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName)
 Export an overloaded 15-ary C++ function to Python, with custom Python name.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC(i_module, f_cppFunction, t_return, t_params, s_doc)
 Export an overloaded C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_0(i_module, f_cppFunction, t_return, s_doc)
 Export an overloaded 0-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_1(i_module, f_cppFunction, t_return, t_P1, s_doc)
 Export an overloaded 1-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_doc)
 Export an overloaded 2-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_doc)
 Export an overloaded 3-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_doc)
 Export an overloaded 4-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_doc)
 Export an overloaded 5-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_doc)
 Export an overloaded 6-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_doc)
 Export an overloaded 7-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_doc)
 Export an overloaded 8-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_doc)
 Export an overloaded 9-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_doc)
 Export an overloaded 10-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_doc)
 Export an overloaded 11-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_doc)
 Export an overloaded 12-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_doc)
 Export an overloaded 13-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_doc)
 Export an overloaded 14-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_doc)
 Export an overloaded 15-ary C++ function to Python, with docstring.
 
#define PY_MODULE_FUNCTION_QUALIFIED(i_module, f_cppFunction, t_return, t_params)
 Export an overloaded C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_0(i_module, f_cppFunction, t_return)
 Export an overloaded 0-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_1(i_module, f_cppFunction, t_return, t_P1)
 Export an overloaded 1-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_2(i_module, f_cppFunction, t_return, t_P1, t_P2)
 Export an overloaded 2-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3)
 Export an overloaded 3-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4)
 Export an overloaded 4-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5)
 Export an overloaded 5-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6)
 Export an overloaded 6-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7)
 Export an overloaded 7-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8)
 Export an overloaded 8-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9)
 Export an overloaded 9-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10)
 Export an overloaded 10-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11)
 Export an overloaded 11-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12)
 Export an overloaded 12-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13)
 Export an overloaded 13-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14)
 Export an overloaded 14-ary C++ function to Python.
 
#define PY_MODULE_FUNCTION_QUALIFIED_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15)
 Export an overloaded 15-ary C++ function to Python.
 

Macro Definition Documentation

◆ PY_MODULE_PY_FUNCTION_EX

#define PY_MODULE_PY_FUNCTION_EX ( i_module,
f_cppFunction,
s_functionName,
s_doc )

Export a C++ function to Python without automatic wrapper generation (deprecated)

Use this macro for backward compatibility when wrapper functions don't need to be automatically generated or you want specific Python behavior.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (must already be a PyCFunction)
s_functionNamePython function name
s_docFunction documentation string
Deprecated
Use PY_MODULE_FUNCTION_EX instead for automatic wrapper generation

Definition at line 622 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_EX

#define PY_MODULE_FUNCTION_EX ( i_module,
f_cppFunction,
s_functionName,
s_doc,
i_dispatcher )

Export a C++ function to Python, with full control.

This is the most flexible function export macro, allowing manual dispatcher naming for creating overloaded Python functions. It should rarely be used in practice, use one of the wrappers that automatically fill in some of the parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction docstring (const char* string with static storage duration), or nullptr
i_dispatcherUnique name for the generated dispatcher (unscoped, it is concatenated)
Example
PY_MODULE_FUNCTION_NAME_DOC(foo, doBar, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)

Definition at line 721 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_NAME_DOC

#define PY_MODULE_FUNCTION_NAME_DOC ( i_module,
f_cppFunction,
s_name,
s_doc )
Value:
PY_MODULE_FUNCTION_EX( i_module, f_cppFunction, s_name, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export a C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_EX() with auto-generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export
s_namePython function name (const char* string with static storage duration)
s_docFunction docstring (const char* string with static storage duration, or nullptr)
Example
PY_MODULE_FUNCTION_NAME_DOC(foo, doBar, "do_bar", "Do Bar") // foo.do_bar(...)

Definition at line 761 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_NAME

#define PY_MODULE_FUNCTION_NAME ( i_module,
f_cppFunction,
s_name )
Value:
PY_MODULE_FUNCTION_NAME_DOC( i_module, f_cppFunction, s_name, 0)

Export a C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_NAME_DOC() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export
s_namePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_NAME(foo, doBar, "do_bar") // foo.do_bar(...)

Definition at line 780 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_DOC

#define PY_MODULE_FUNCTION_DOC ( i_module,
f_cppFunction,
s_doc )
Value:
PY_MODULE_FUNCTION_NAME_DOC( i_module, f_cppFunction, LASS_STRINGIFY(f_cppFunction), s_doc)

Export a C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_NAME_DOC() with s_name derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (name will be used as Python name)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_DOC(foo, doBar, "Do Bar") // foo.doBar(...)

Definition at line 798 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION

#define PY_MODULE_FUNCTION ( i_module,
f_cppFunction )
Value:
PY_MODULE_FUNCTION_NAME_DOC( i_module, f_cppFunction, LASS_STRINGIFY(f_cppFunction), 0)

Export a C++ function to Python.

Wraps PY_MODULE_FUNCTION_NAME_DOC() with defaults.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (name will be used as Python name)
Example
PY_MODULE_FUNCTION(foo, doBar) // foo.doBar(...)

Definition at line 815 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX

#define PY_MODULE_FUNCTION_QUALIFIED_EX ( i_module,
f_cppFunction,
t_return,
t_params,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded C++ function to Python, with full control.

Use this macro instead of PY_MODULE_FUNCTION_EX when there are overloaded C++ functions that would create ambiguity. By explicitly specifying return type and parameter types, you can disambiguate which overload to export.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_paramsParameter types as lass::meta::TypeTuple (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction docstring (const char* string with static storage duration, or nullptr)
i_dispatcherUnique name for the generated dispatcher function (unscoped identifier for token concatenation)

This macro helps resolve function overload ambiguities by explicitly specifying the function signature to export.

Example
void bar(int a);
void bar(const std::string& b);
PY_MODULE_FUNCTION_QUALIFIED_EX(foo, bar, void, meta::TypeTuple<int>, "bar", nullptr, foo_bar_a)
PY_MODULE_FUNCTION_QUALIFIED_EX(foo, bar, void, meta::TypeTuple<const std::string&>, "bar", nullptr, foo_bar_b)
#define PY_MODULE_FUNCTION_QUALIFIED_EX(i_module, f_cppFunction, t_return, t_params, s_functionName, s_doc, i_dispatcher)
Export an overloaded C++ function to Python, with full control.

Definition at line 1815 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_0

#define PY_MODULE_FUNCTION_QUALIFIED_EX_0 ( i_module,
f_cppFunction,
t_return,
s_functionName,
s_doc,
i_dispatcher )
Value:
i_module, f_cppFunction, t_return, ::lass::meta::TypeTuple<>, s_functionName, s_doc, i_dispatcher )
An ordered list of types.
Definition type_tuple.h:74

Export an overloaded 0-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with 0 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_0(foo, doBar, R, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_0(i_module, f_cppFunction, t_return, s_functionName, s_doc, i_dispatcher)
Export an overloaded 0-ary C++ function to Python, with full control.

Definition at line 1863 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_1

#define PY_MODULE_FUNCTION_QUALIFIED_EX_1 ( i_module,
f_cppFunction,
t_return,
t_P1,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 1-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 1 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_1(foo, doBar, R, P1, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_1(i_module, f_cppFunction, t_return, t_P1, s_functionName, s_doc, i_dispatcher)
Export an overloaded 1-ary C++ function to Python, with full control.

Definition at line 1886 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_2

#define PY_MODULE_FUNCTION_QUALIFIED_EX_2 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 2-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 2 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_2(foo, doBar, R, P1, P2, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName, s_doc, i_dispatcher)
Export an overloaded 2-ary C++ function to Python, with full control.

Definition at line 1913 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_3

#define PY_MODULE_FUNCTION_QUALIFIED_EX_3 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 3-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 3 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_3(foo, doBar, R, P1, P2, P3, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName, s_doc, i_dispatcher)
Export an overloaded 3-ary C++ function to Python, with full control.

Definition at line 1940 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_4

#define PY_MODULE_FUNCTION_QUALIFIED_EX_4 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 4-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 4 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_4(foo, doBar, R, P1, P2, P3, P4, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName, s_doc, i_dispatcher)
Export an overloaded 4-ary C++ function to Python, with full control.

Definition at line 1967 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_5

#define PY_MODULE_FUNCTION_QUALIFIED_EX_5 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 5-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 5 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_5(foo, doBar, R, P1, P2, P3, P4, P5, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName, s_doc, i_dispatcher)
Export an overloaded 5-ary C++ function to Python, with full control.

Definition at line 1994 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_6

#define PY_MODULE_FUNCTION_QUALIFIED_EX_6 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 6-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 6 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_6(foo, doBar, R, P1, P2, P3, P4, P5, P6, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName, s_doc, i_dispatcher)
Export an overloaded 6-ary C++ function to Python, with full control.

Definition at line 2021 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_7

#define PY_MODULE_FUNCTION_QUALIFIED_EX_7 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 7-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 7 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_7(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName, s_doc, i_dispatcher)
Export an overloaded 7-ary C++ function to Python, with full control.

Definition at line 2048 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_8

#define PY_MODULE_FUNCTION_QUALIFIED_EX_8 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 8-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 8 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_8(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName, s_doc, i_dispatcher)
Export an overloaded 8-ary C++ function to Python, with full control.

Definition at line 2075 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_9

#define PY_MODULE_FUNCTION_QUALIFIED_EX_9 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 9-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 9 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_9(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName, s_doc, i_dispatcher)
Export an overloaded 9-ary C++ function to Python, with full control.

Definition at line 2102 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_10

#define PY_MODULE_FUNCTION_QUALIFIED_EX_10 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 10-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 10 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_10(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName, s_doc, i_dispatcher)
Export an overloaded 10-ary C++ function to Python, with full control.

Definition at line 2129 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_11

#define PY_MODULE_FUNCTION_QUALIFIED_EX_11 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 11-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 11 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_11(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName, s_doc, i_dispatcher)
Export an overloaded 11-ary C++ function to Python, with full control.

Definition at line 2156 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_12

#define PY_MODULE_FUNCTION_QUALIFIED_EX_12 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 12-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 12 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_12(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName, s_doc, i_dispatcher)
Export an overloaded 12-ary C++ function to Python, with full control.

Definition at line 2183 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_13

#define PY_MODULE_FUNCTION_QUALIFIED_EX_13 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 13-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 13 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_13(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName, s_doc, i_dispatcher)
Export an overloaded 13-ary C++ function to Python, with full control.

Definition at line 2210 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_14

#define PY_MODULE_FUNCTION_QUALIFIED_EX_14 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 14-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 14 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_14(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName, s_doc, i_dispatcher)
Export an overloaded 14-ary C++ function to Python, with full control.

Definition at line 2237 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_EX_15

#define PY_MODULE_FUNCTION_QUALIFIED_EX_15 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
t_P15,
s_functionName,
s_doc,
i_dispatcher )

Export an overloaded 15-ary C++ function to Python, with full control.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() for functions with exactly 15 parameters.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14,t_P15Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
i_dispatcherUnique identifier for the function dispatcher
Example
PY_MODULE_FUNCTION_QUALIFIED_EX_15(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, "do_bar", "Do Bar", foo_do_bar) // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_EX_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName, s_doc, i_dispatcher)
Export an overloaded 15-ary C++ function to Python, with full control.

Definition at line 2264 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC ( i_module,
f_cppFunction,
t_return,
t_params,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_params, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_paramsParameter types as lass::meta::TypeTuple (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC(foo, doBar, R, (TypeTuple<P1, P2, P3>), "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC(i_module, f_cppFunction, t_return, t_params, s_functionName, s_doc)
Export an overloaded C++ function to Python, with custom name and docstring.

Definition at line 2291 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_0

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_0 ( i_module,
f_cppFunction,
t_return,
t_params,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 0-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_0() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_paramsUnused, you can set it to void
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Note
t_params is a stray parameter that deviates from the pattern. It's here for historical backward compatibility.
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_015(foo, doBar, R, void, "do_bar", "Do Bar") // foo.do_bar(...)

Definition at line 2318 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_1

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_1 ( i_module,
f_cppFunction,
t_return,
t_P1,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 1-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_1() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_1(foo, doBar, R, P1, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_1(i_module, f_cppFunction, t_return, t_P1, s_functionName, s_doc)
Export an overloaded 1-ary C++ function to Python, with custom name and docstring.

Definition at line 2341 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_2

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_2 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 2-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_2() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_2(foo, doBar, R, P1, P2, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName, s_doc)
Export an overloaded 2-ary C++ function to Python, with custom name and docstring.

Definition at line 2364 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_3

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_3 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 3-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_3() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_3(foo, doBar, R, P1, P2, P3, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName, s_doc)
Export an overloaded 3-ary C++ function to Python, with custom name and docstring.

Definition at line 2387 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_4

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_4 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 4-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_4() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_4(foo, doBar, R, P1, P2, P3, P4, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName, s_doc)
Export an overloaded 4-ary C++ function to Python, with custom name and docstring.

Definition at line 2410 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_5

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_5 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 5-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_5() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_5(foo, doBar, R, P1, P2, P3, P4, P5, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName, s_doc)
Export an overloaded 5-ary C++ function to Python, with custom name and docstring.

Definition at line 2433 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_6

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_6 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 6-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_6() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_6(foo, doBar, R, P1, P2, P3, P4, P5, P6, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName, s_doc)
Export an overloaded 6-ary C++ function to Python, with custom name and docstring.

Definition at line 2456 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_7

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_7 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 7-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_7() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_7(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName, s_doc)
Export an overloaded 7-ary C++ function to Python, with custom name and docstring.

Definition at line 2479 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_8

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_8 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 8-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_8() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_8(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName, s_doc)
Export an overloaded 8-ary C++ function to Python, with custom name and docstring.

Definition at line 2502 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_9

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_9 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 9-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_9() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_9(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName, s_doc)
Export an overloaded 9-ary C++ function to Python, with custom name and docstring.

Definition at line 2525 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_10

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_10 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 10-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_10() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_10(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName, s_doc)
Export an overloaded 10-ary C++ function to Python, with custom name and docstring.

Definition at line 2548 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_11

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_11 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 11-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_11() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_11(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName, s_doc)
Export an overloaded 11-ary C++ function to Python, with custom name and docstring.

Definition at line 2571 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_12

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_12 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 12-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_12() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_12(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName, s_doc)
Export an overloaded 12-ary C++ function to Python, with custom name and docstring.

Definition at line 2594 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_13

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_13 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 13-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_13() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_13(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName, s_doc)
Export an overloaded 13-ary C++ function to Python, with custom name and docstring.

Definition at line 2617 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_14

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_14 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 14-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_14() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_14(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName, s_doc)
Export an overloaded 14-ary C++ function to Python, with custom name and docstring.

Definition at line 2640 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_15

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_15 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
t_P15,
s_functionName,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName, s_doc,\
LASS_UNIQUENAME(LASS_CONCATENATE(lassPyImpl_function_, i_module)))

Export an overloaded 15-ary C++ function to Python, with custom name and docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_EX_15() with automatically generated dispatcher name.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14,t_P15Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_15(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, "do_bar", "Do Bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName, s_doc)
Export an overloaded 15-ary C++ function to Python, with custom name and docstring.

Definition at line 2663 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME

#define PY_MODULE_FUNCTION_QUALIFIED_NAME ( i_module,
f_cppFunction,
t_return,
t_params,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_params, s_functionName, 0 )

Export an overloaded C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_paramsParameter types as lass::meta::TypeTuple (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC(foo, doBar, R, (TypeTuple<P1, P2, P3>), "do_bar") // foo.do_bar(...)

Definition at line 2686 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_0

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_0 ( i_module,
f_cppFunction,
t_return,
s_functionName )
Value:
i_module, f_cppFunction, t_return, s_functionName, 0 )
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_0(i_module, f_cppFunction, t_return, t_params, s_functionName, s_doc)
Export an overloaded 0-ary C++ function to Python, with custom name and docstring.

Export an overloaded 0-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_0() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_0(foo, doBar, R, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_0(i_module, f_cppFunction, t_return, s_functionName)
Export an overloaded 0-ary C++ function to Python, with custom Python name.

Definition at line 2706 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_1

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_1 ( i_module,
f_cppFunction,
t_return,
t_P1,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, s_functionName, 0 )

Export an overloaded 1-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_1() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_1(foo, doBar, R, P1, "do_bar") // foo.do_bar(...)

Definition at line 2727 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_2

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_2 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, s_functionName, 0 )

Export an overloaded 2-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_2() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_2(foo, doBar, R, P1, P2, "do_bar") // foo.do_bar(...)

Definition at line 2748 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_3

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_3 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName, 0 )

Export an overloaded 3-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_3() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_3(foo, doBar, R, P1, P2, P3, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_functionName)
Export an overloaded 3-ary C++ function to Python, with custom Python name.

Definition at line 2769 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_4

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_4 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName, 0 )

Export an overloaded 4-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_4() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_4(foo, doBar, R, P1, P2, P3, P4, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_functionName)
Export an overloaded 4-ary C++ function to Python, with custom Python name.

Definition at line 2790 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_5

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_5 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName, 0 )

Export an overloaded 5-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_5() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_5(foo, doBar, R, P1, P2, P3, P4, P5, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_functionName)
Export an overloaded 5-ary C++ function to Python, with custom Python name.

Definition at line 2811 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_6

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_6 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName, 0 )

Export an overloaded 6-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_6() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_6(foo, doBar, R, P1, P2, P3, P4, P5, P6, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_functionName)
Export an overloaded 6-ary C++ function to Python, with custom Python name.

Definition at line 2832 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_7

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_7 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName, 0 )

Export an overloaded 7-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_7() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_7(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_functionName)
Export an overloaded 7-ary C++ function to Python, with custom Python name.

Definition at line 2853 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_8

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_8 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName, 0 )

Export an overloaded 8-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_8() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_8(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_functionName)
Export an overloaded 8-ary C++ function to Python, with custom Python name.

Definition at line 2874 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_9

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_9 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName, 0 )

Export an overloaded 9-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_9() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_9(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_functionName)
Export an overloaded 9-ary C++ function to Python, with custom Python name.

Definition at line 2895 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_10

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_10 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName, 0 )

Export an overloaded 10-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_10() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_10(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_functionName)
Export an overloaded 10-ary C++ function to Python, with custom Python name.

Definition at line 2916 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_11

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_11 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName, 0 )

Export an overloaded 11-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_11() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_11(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_functionName)
Export an overloaded 11-ary C++ function to Python, with custom Python name.

Definition at line 2937 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_12

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_12 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName, 0 )

Export an overloaded 12-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_12() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_12(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_functionName)
Export an overloaded 12-ary C++ function to Python, with custom Python name.

Definition at line 2958 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_13

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_13 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName, 0 )

Export an overloaded 13-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_13() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_13(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_functionName)
Export an overloaded 13-ary C++ function to Python, with custom Python name.

Definition at line 2979 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_14

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_14 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName, 0 )

Export an overloaded 14-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_14() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_14(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_functionName)
Export an overloaded 14-ary C++ function to Python, with custom Python name.

Definition at line 3000 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_NAME_15

#define PY_MODULE_FUNCTION_QUALIFIED_NAME_15 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
t_P15,
s_functionName )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName, 0 )

Export an overloaded 15-ary C++ function to Python, with custom Python name.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_15() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (may be overloaded)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14,t_P15Parameter types for the function (for disambiguation)
s_functionNamePython function name (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_15(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, "do_bar") // foo.do_bar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_NAME_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_functionName)
Export an overloaded 15-ary C++ function to Python, with custom Python name.

Definition at line 3021 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC

#define PY_MODULE_FUNCTION_QUALIFIED_DOC ( i_module,
f_cppFunction,
t_return,
t_params,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_params, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (may be overloaded, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_paramsParameter types as lass::meta::TypeTuple (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC(foo, doBar, R, (TypeTuple<P1, P2, P3>), "Do Bar") // foo.doBar(...)

Definition at line 3044 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_0

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_0 ( i_module,
f_cppFunction,
t_return,
s_doc )
Value:
i_module, f_cppFunction, t_return, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 0-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_0() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (0 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_0(foo, doBar, R, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_0(i_module, f_cppFunction, t_return, s_doc)
Export an overloaded 0-ary C++ function to Python, with docstring.

Definition at line 3065 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_1

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_1 ( i_module,
f_cppFunction,
t_return,
t_P1,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 1-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_1() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (1 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_1(foo, doBar, R, P1, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_1(i_module, f_cppFunction, t_return, t_P1, s_doc)
Export an overloaded 1-ary C++ function to Python, with docstring.

Definition at line 3087 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_2

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_2 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 2-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_2() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (2 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_2(foo, doBar, R, P1, P2, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_2(i_module, f_cppFunction, t_return, t_P1, t_P2, s_doc)
Export an overloaded 2-ary C++ function to Python, with docstring.

Definition at line 3109 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_3

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_3 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 3-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_3() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (3 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_3(foo, doBar, R, P1, P2, P3, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, s_doc)
Export an overloaded 3-ary C++ function to Python, with docstring.

Definition at line 3131 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_4

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_4 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 4-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_4() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (4 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_4(foo, doBar, R, P1, P2, P3, P4, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, s_doc)
Export an overloaded 4-ary C++ function to Python, with docstring.

Definition at line 3153 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_5

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_5 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 5-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_5() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (5 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_5(foo, doBar, R, P1, P2, P3, P4, P5, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, s_doc)
Export an overloaded 5-ary C++ function to Python, with docstring.

Definition at line 3175 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_6

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_6 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 6-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_6() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (6 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_6(foo, doBar, R, P1, P2, P3, P4, P5, P6, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, s_doc)
Export an overloaded 6-ary C++ function to Python, with docstring.

Definition at line 3197 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_7

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_7 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 7-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_7() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (7 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_7(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, s_doc)
Export an overloaded 7-ary C++ function to Python, with docstring.

Definition at line 3219 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_8

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_8 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 8-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_8() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (8 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_8(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, s_doc)
Export an overloaded 8-ary C++ function to Python, with docstring.

Definition at line 3241 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_9

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_9 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 9-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_9() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (9 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_9(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, s_doc)
Export an overloaded 9-ary C++ function to Python, with docstring.

Definition at line 3263 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_10

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_10 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 10-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_10() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (10 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_10(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, s_doc)
Export an overloaded 10-ary C++ function to Python, with docstring.

Definition at line 3285 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_11

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_11 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 11-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_11() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (11 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_11(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, s_doc)
Export an overloaded 11-ary C++ function to Python, with docstring.

Definition at line 3307 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_12

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_12 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 12-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_12() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (12 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_12(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, s_doc)
Export an overloaded 12-ary C++ function to Python, with docstring.

Definition at line 3329 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_13

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_13 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 13-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_13() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (13 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_13(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, s_doc)
Export an overloaded 13-ary C++ function to Python, with docstring.

Definition at line 3351 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_14

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_14 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 14-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_14() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (14 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_14(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, s_doc)
Export an overloaded 14-ary C++ function to Python, with docstring.

Definition at line 3373 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_DOC_15

#define PY_MODULE_FUNCTION_QUALIFIED_DOC_15 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
t_P15,
s_doc )
Value:
i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, LASS_STRINGIFY(f_cppFunction), s_doc)

Export an overloaded 15-ary C++ function to Python, with docstring.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC_15() with s_functionName derived from f_cppFunction.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (15 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14,t_P15Parameter types for the function (for disambiguation)
s_docFunction documentation string (const char* string with static storage duration)
Example
PY_MODULE_FUNCTION_QUALIFIED_DOC_15(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, "Do Bar") // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_DOC_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, s_doc)
Export an overloaded 15-ary C++ function to Python, with docstring.

Definition at line 3395 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED

#define PY_MODULE_FUNCTION_QUALIFIED ( i_module,
f_cppFunction,
t_return,
t_params )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC( i_module, f_cppFunction, t_return, t_params, 0 )
#define PY_MODULE_FUNCTION_QUALIFIED_DOC(i_module, f_cppFunction, t_return, t_params, s_doc)
Export an overloaded C++ function to Python, with docstring.

Export an overloaded C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC() with defaults.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (may be overloaded, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_paramsParameter types as lass::meta::TypeTuple (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_NAME_DOC(foo, doBar, R, (TypeTuple<P1, P2, P3>)) // foo.doBar(...)

Definition at line 3416 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_0

#define PY_MODULE_FUNCTION_QUALIFIED_0 ( i_module,
f_cppFunction,
t_return )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_0( i_module, f_cppFunction, t_return, 0 )

Export an overloaded 0-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_0() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*
f_cppFunctionC++ function to export (0 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_0(foo, doBar, R) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_0(i_module, f_cppFunction, t_return)
Export an overloaded 0-ary C++ function to Python.

Definition at line 3434 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_1

#define PY_MODULE_FUNCTION_QUALIFIED_1 ( i_module,
f_cppFunction,
t_return,
t_P1 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_1( i_module, f_cppFunction, t_return, t_P1, 0 )

Export an overloaded 1-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_1() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (1 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_1(foo, doBar, R, P1) // foo.doBar(...)

Definition at line 3453 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_2

#define PY_MODULE_FUNCTION_QUALIFIED_2 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_2( i_module, f_cppFunction, t_return, t_P1, t_P2, 0 )

Export an overloaded 2-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_2() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (2 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_2(foo, doBar, R, P1, P2) // foo.doBar(...)

Definition at line 3472 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_3

#define PY_MODULE_FUNCTION_QUALIFIED_3 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_3( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, 0 )

Export an overloaded 3-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_3() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (3 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_3(foo, doBar, R, P1, P2, P3) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_3(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3)
Export an overloaded 3-ary C++ function to Python.

Definition at line 3491 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_4

#define PY_MODULE_FUNCTION_QUALIFIED_4 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_4( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, 0 )

Export an overloaded 4-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_4() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (4 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_4(foo, doBar, R, P1, P2, P3, P4) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_4(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4)
Export an overloaded 4-ary C++ function to Python.

Definition at line 3510 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_5

#define PY_MODULE_FUNCTION_QUALIFIED_5 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_5( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, 0 )

Export an overloaded 5-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_5() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (5 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_5(foo, doBar, R, P1, P2, P3, P4, P5) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_5(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5)
Export an overloaded 5-ary C++ function to Python.

Definition at line 3529 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_6

#define PY_MODULE_FUNCTION_QUALIFIED_6 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_6( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, 0 )

Export an overloaded 6-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_6() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (6 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_6(foo, doBar, R, P1, P2, P3, P4, P5, P6) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_6(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6)
Export an overloaded 6-ary C++ function to Python.

Definition at line 3548 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_7

#define PY_MODULE_FUNCTION_QUALIFIED_7 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_7( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, 0 )

Export an overloaded 7-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_7() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (7 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_7(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_7(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7)
Export an overloaded 7-ary C++ function to Python.

Definition at line 3567 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_8

#define PY_MODULE_FUNCTION_QUALIFIED_8 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_8( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, 0 )

Export an overloaded 8-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_8() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (8 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_8(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_8(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8)
Export an overloaded 8-ary C++ function to Python.

Definition at line 3586 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_9

#define PY_MODULE_FUNCTION_QUALIFIED_9 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_9( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, 0 )

Export an overloaded 9-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_9() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (9 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_9(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_9(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9)
Export an overloaded 9-ary C++ function to Python.

Definition at line 3605 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_10

#define PY_MODULE_FUNCTION_QUALIFIED_10 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_10( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, 0 )

Export an overloaded 10-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_10() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (10 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_10(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_10(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10)
Export an overloaded 10-ary C++ function to Python.

Definition at line 3624 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_11

#define PY_MODULE_FUNCTION_QUALIFIED_11 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_11( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, 0 )

Export an overloaded 11-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_11() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (11 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_11(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_11(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11)
Export an overloaded 11-ary C++ function to Python.

Definition at line 3643 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_12

#define PY_MODULE_FUNCTION_QUALIFIED_12 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_12( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, 0 )

Export an overloaded 12-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_12() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (12 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_12(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_12(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12)
Export an overloaded 12-ary C++ function to Python.

Definition at line 3662 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_13

#define PY_MODULE_FUNCTION_QUALIFIED_13 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_13( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, 0 )

Export an overloaded 13-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_13() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (13 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_13(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_13(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13)
Export an overloaded 13-ary C++ function to Python.

Definition at line 3681 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_14

#define PY_MODULE_FUNCTION_QUALIFIED_14 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_14( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, 0 )

Export an overloaded 14-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_14() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (14 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_14(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_14(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14)
Export an overloaded 14-ary C++ function to Python.

Definition at line 3700 of file pyobject_macros.h.

◆ PY_MODULE_FUNCTION_QUALIFIED_15

#define PY_MODULE_FUNCTION_QUALIFIED_15 ( i_module,
f_cppFunction,
t_return,
t_P1,
t_P2,
t_P3,
t_P4,
t_P5,
t_P6,
t_P7,
t_P8,
t_P9,
t_P10,
t_P11,
t_P12,
t_P13,
t_P14,
t_P15 )
Value:
PY_MODULE_FUNCTION_QUALIFIED_DOC_15( i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15, 0 )

Export an overloaded 15-ary C++ function to Python.

Wraps PY_MODULE_FUNCTION_QUALIFIED_DOC_15() with s_doc = nullptr.

Parameters
i_moduleModule identifier declared by PY_DECLARE_MODULE_*()
f_cppFunctionC++ function to export (15 parameters, name will be used as Python name)
t_returnReturn type of the function (for disambiguation)
t_P1,t_P2,t_P3,t_P4,t_P5,t_P6,t_P7,t_P8,t_P9,t_P10,t_P11,t_P12,t_P13,t_P14,t_P15Parameter types for the function (for disambiguation)
Example
PY_MODULE_FUNCTION_QUALIFIED_15(foo, doBar, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15) // foo.doBar(...)
#define PY_MODULE_FUNCTION_QUALIFIED_15(i_module, f_cppFunction, t_return, t_P1, t_P2, t_P3, t_P4, t_P5, t_P6, t_P7, t_P8, t_P9, t_P10, t_P11, t_P12, t_P13, t_P14, t_P15)
Export an overloaded 15-ary C++ function to Python.

Definition at line 3719 of file pyobject_macros.h.