PythonPlanIndexedCollMacros.h

Go to the documentation of this file.

// PythonPlanIndexedCollMacros.h:
// ------------------------------
//

#ifndef __PYIPSDKBASE_PYTHONPLANINDEXEDCOLLMACROS_H__
#define __PYIPSDKBASE_PYTHONPLANINDEXEDCOLLMACROS_H__

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


#if (defined(_MSC_VER) && _MSC_VER == 1900)
#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_WORKAROUND(planIndexedNodesName)                                     \
    static_cast<planIndexedNodesName const volatile* (*)(class planIndexedNodesName const volatile*)>(boost::get_pointer<planIndexedNodesName const volatile>);
#else
#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_WORKAROUND(planIndexedNodesName)
#endif


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

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_TOPYDICT_SPECIALIZED(planIndexedNodesName)              \
    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");

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_TEMPLATED(planIndexedNodesName)                   \
    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");

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_EQUAL_SPECIALIZED(planIndexedNodesName)                 \
    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");

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CONVERTIBLE(planIndexedNodesName)               \
    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>();                    \

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_CLASS_EXPORT(planIndexedNodesName, tooltipStr)  \
    boost::python::class_<planIndexedNodesName,                                                 \
                          bases<ipsdk::BasePlanIndexedColl>,                                    \
                          boost::shared_ptr<planIndexedNodesName>,                              \
                          boost::noncopyable>(                                                  \
        BOOST_PP_STRINGIZE(planIndexedNodesName),                                               \
        tooltipStr,                                                                             \
        boost::python::no_init)                                                                 \
    .def("getElementsClassName",                                                                \
         &planIndexedNodesName::getElementsClassName,                                           \
         return_value_policy<copy_const_reference>(),                                           \
         "retrieve class name associated to concrete elements into collection")                 \
    .def("getValue",                                                                            \
         static_cast<const planIndexedNodesName::ValueType& (planIndexedNodesName::*)           \
                     (const ipsdk::PlanIndex&) const>(&planIndexedNodesName::getValue),         \
         return_internal_reference<>(),                                                         \
         "retrieve an element associated to a given plan index")                                \
    .def("getValue",                                                                            \
         static_cast<const planIndexedNodesName::ValueType& (planIndexedNodesName::*)           \
            (const ipsdk::ipUInt64, const ipsdk::ipUInt64, const ipsdk::ipUInt64) const>        \
            (&planIndexedNodesName::getValue),                                                  \
         return_internal_reference<>(),                                                         \
         "retrieve an element associated to a given plan index")                                \
    .def("getValue",                                                                            \
         static_cast<const planIndexedNodesName::ValueType& (planIndexedNodesName::*)           \
                     (const ipsdk::ipUInt64) const>(&planIndexedNodesName::getValue),           \
         return_internal_reference<>(),                                                         \
         "retrieve an element associated to a given plan offset")                               \
    .def("getValue",                                                                            \
         static_cast<planIndexedNodesName::ValueType& (planIndexedNodesName::*)                 \
            (const ipsdk::PlanIndex&)>(&planIndexedNodesName::getValue),                        \
         return_internal_reference<>(),                                                         \
         "retrieve an element associated to a given plan index")                                \
    .def("getValue",                                                                            \
         static_cast<planIndexedNodesName::ValueType& (planIndexedNodesName::*)                 \
            (const ipsdk::ipUInt64, const ipsdk::ipUInt64, const ipsdk::ipUInt64)>              \
            (&planIndexedNodesName::getValue),                                                  \
         return_internal_reference<>(),                                                         \
         "retrieve an element associated to a given plan index")                                \
    .def("getValue",                                                                            \
         static_cast<planIndexedNodesName::ValueType& (planIndexedNodesName::*)                 \
            (const ipsdk::ipUInt64)>                                                            \
            (&planIndexedNodesName::getValue),                                                  \
         return_internal_reference<>(),                                                         \
         "retrieve an element associated to a given plan offset")                               \
    .def("insert",                                                                              \
         static_cast<void (planIndexedNodesName::*)                                             \
            (const ipsdk::ipUInt64, const ipsdk::ipUInt64, const ipsdk::ipUInt64,               \
             const planIndexedNodesName::StorageType&)>                                         \
             (&planIndexedNodesName::insert),                                                   \
         "insert a new element for a given plan index")                                         \
    .def("insert",                                                                              \
         static_cast<void (planIndexedNodesName::*)                                             \
            (const ipsdk::PlanIndex&,                                                           \
             const planIndexedNodesName::StorageType&)>                                         \
             (&planIndexedNodesName::insert),                                                   \
         "insert a new element for a given plan index")                                         \
    .def("assign", &planIndexedNodesName::assign,                                               \
         "assign a given value to all data of collection")


#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER(planIndexedNodesName, tooltipStr)               \
    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)

#define IPSDK_PYTHON_PLAN_INDEXED_NODES_WRAPPER_SPECIALIZED(planIndexedNodesName, tooltipStr)   \
    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)


#endif // __PYIPSDKBASE_PYTHONPLANINDEXEDCOLLMACROS_H__