PythonPlanIndexedCollMacros.h File Reference

Macros set used to wrap IPSDKplan indexed collections to python. More...

#include <Python/PyIPSDKBase/PythonMacros.h>
#include <Python/PyIPSDKBase/PythonPlanIndexedColl.h>
#include <boost/noncopyable.hpp>

Go to the source code of this file.

Macros
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_WORKAROUND(planIndexedNodesName)
	macro to avoid link errors generated by VC2015 SP3 when IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER is used
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_TEMPLATED(planIndexedNodesName)
	macro allowing to use PyIPSDK.toPyDict() on a plan indexed node This macro uses a generic templated definition of ipsdk::python::toPyDict More...
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_SPECIALIZED(planIndexedNodesName)
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_TEMPLATED(planIndexedNodesName)
	macro allowing to use PyIPSDK.equal() and ipsdk::python::equalWithoutTol() on a plan indexed node. This macro uses generic templated definitions of ipsdk::python::equal[WithoutTol] More...
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_SPECIALIZED(planIndexedNodesName)
	macro allowing to use PyIPSDK.toPyDict() on a plan indexed node Some nodes such as ipsdk::shape::analysis::PlanIndexedMeasureSet need a specific overload of the templated function ipsdk::python::toPyDict This macro uses a specific definition of ipsdk::python::toPyDict More...
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CONVERTIBLE(planIndexedNodesName)
	macro allowing toimplicitly convert a plan indexed node into shared_ptr More...
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CLASS_EXPORT(planIndexedNodesName, tooltipStr)
	macro allowing to wrap an IPSDK plan indexed class to python
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER(planIndexedNodesName, tooltipStr)
	macro allowing to wrap an IPSDK plan indexed nodes collection to python by using generic templated functions More...
#define	IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_SPECIALIZED(planIndexedNodesName, tooltipStr)
	macro allowing to wrap an IPSDK plan indexed nodes collection to python by using specific overloaded functions More...

Detailed Description

Macros set used to wrap IPSDKplan indexed collections to python.

Author

E. Noirfalise

Date

2015/12/03

Copyright

2015 Reactiv'IP, all right reserved.

Macro Definition Documentation

IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_TEMPLATED

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_TEMPLATED

(

planIndexedNodesName

)

Value:

def("toPyDict",                                                                             \
        ipsdk::python::toPyDict<planIndexedNodesName>,                                          \
        "function allowing to convert an IPSDK plan indexed data item collection "              \
        "to a python dictionnary containing its data");

macro allowing to use PyIPSDK.toPyDict() on a plan indexed node This macro uses a generic templated definition of ipsdk::python::toPyDict

IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_SPECIALIZED

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_SPECIALIZED

(

planIndexedNodesName

)

Value:

def("toPyDict",                                                                             \
        BOOST_PP_CAT(planIndexedNodesName, ToPyDict),                                           \
        "function allowing to convert an IPSDK plan indexed data item collection "              \
        "to a python dictionnary containing its data");

IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_TEMPLATED

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_TEMPLATED

(

planIndexedNodesName

)

Value:

def("equal",                                                                                \
        ipsdk::python::equal<planIndexedNodesName>,                                             \
        "function allowing to compare two plan indexed data item collections");                 \
    def("equal",                                                                                \
        ipsdk::python::equalWithoutTol<planIndexedNodesName>,                                   \
        "function allowing to compare two plan indexed data item collections");

macro allowing to use PyIPSDK.equal() and ipsdk::python::equalWithoutTol() on a plan indexed node. This macro uses generic templated definitions of ipsdk::python::equal[WithoutTol]

IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_SPECIALIZED

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_SPECIALIZED

(

planIndexedNodesName

)

Value:

def("equal",                                                                                \
        BOOST_PP_CAT(planIndexedNodesName, Equality),                                           \
        "function allowing to compare two plan indexed data item collections");                 \
    def("equal",                                                                                \
        BOOST_PP_CAT(planIndexedNodesName, EqualityWithoutTol),                                 \
        "function allowing to compare two plan indexed data item collections");

macro allowing to use PyIPSDK.toPyDict() on a plan indexed node Some nodes such as ipsdk::shape::analysis::PlanIndexedMeasureSet need a specific overload of the templated function ipsdk::python::toPyDict This macro uses a specific definition of ipsdk::python::toPyDict

macro allowing to use PyIPSDK.equal() and ipsdk::python::equalWithoutTol() on a plan indexed node. Some nodes such as ipsdk::shape::analysis::PlanIndexedMeasureSet need a specific overload of the templated function ipsdk::python::equal[WithoutTol] This macro uses specific definitions of ipsdk::python::equal[WithoutTol]

IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CONVERTIBLE

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CONVERTIBLE

(

planIndexedNodesName

)

Value:

boost::python::implicitly_convertible<boost::shared_ptr<planIndexedNodesName>,              \
                                          boost::shared_ptr<const planIndexedNodesName> >();    \
    boost::python::implicitly_convertible<boost::shared_ptr<planIndexedNodesName>,              \
                                          ipsdk::PlanIndexedCollPtr>();                         \
    boost::python::implicitly_convertible<boost::shared_ptr<planIndexedNodesName>,              \
                                          ipsdk::PlanIndexedCollConstPtr>();                    \
    boost::python::implicitly_convertible<boost::shared_ptr<const planIndexedNodesName>,        \
                                          ipsdk::PlanIndexedCollConstPtr>();                    \

macro allowing toimplicitly convert a plan indexed node into shared_ptr

IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER	(		planIndexedNodesName,
			tooltipStr
	)

Value:

IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CONVERTIBLE(planIndexedNodesName)                   \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_WORKAROUND(planIndexedNodesName);                   \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_TEMPLATED(planIndexedNodesName)                    \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_TEMPLATED(planIndexedNodesName)                       \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CLASS_EXPORT(planIndexedNodesName, tooltipStr)

macro allowing to wrap an IPSDK plan indexed nodes collection to python by using generic templated functions

IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_SPECIALIZED

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_SPECIALIZED	(		planIndexedNodesName,
			tooltipStr
	)

Value:

IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CONVERTIBLE(planIndexedNodesName)                   \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_WORKAROUND(planIndexedNodesName);                   \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_SPECIALIZED(planIndexedNodesName)                  \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_SPECIALIZED(planIndexedNodesName)                     \
    IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CLASS_EXPORT(planIndexedNodesName, tooltipStr)

macro allowing to wrap an IPSDK plan indexed nodes collection to python by using specific overloaded functions