PythonProcessorMacros.h

Go to the documentation of this file.

// PythonProcessorMacros.h:
// ------------------------
//

#ifndef __PYIPSDKBASE_PYTHONPROCESSORMACROS_H__
#define __PYIPSDKBASE_PYTHONPROCESSORMACROS_H__

#include <Python/PyIPSDKBase/PythonMacros.h>
#include <IPSDKBaseProcessing/Processor/ProcessorTypes.h>
#include <IPSDKImage/Image/BaseImage.h>
#include <IPSDKCore/Processing/Action/BaseAction.h>
#include <boost/noncopyable.hpp>


#if (defined(_MSC_VER) && _MSC_VER == 1900)
#define IPSDK_REGISTER_PROCESSOR_TO_PYTHON_BOOST_WORKAROUND(processorName)                \
    static_cast<BOOST_PP_CAT(processorName, Lvl1) const volatile* (*)(class BOOST_PP_CAT(processorName, Lvl1) const volatile*)>(boost::get_pointer<BOOST_PP_CAT(processorName, Lvl1) const volatile>);
#else
#define IPSDK_REGISTER_PROCESSOR_TO_PYTHON_BOOST_WORKAROUND(processorName)
#endif


#define IPSDK_REGISTER_PROCESSOR_TO_PYTHON(processorName)                           \
    boost::python::class_<BOOST_PP_CAT(processorName, Lvl1),                        \
                          boost::shared_ptr<BOOST_PP_CAT(processorName, Lvl1)>,     \
                          boost::noncopyable>(                                      \
        BOOST_PP_STRINGIZE(BOOST_PP_CAT(processorName, Lvl1)),                      \
        BOOST_PP_CAT(processorName, Lvl1)::getToolTipStr().c_str(),                 \
        boost::python::no_init)                                                     \
    .def("getToolTip",                                                              \
         &BOOST_PP_CAT(processorName, Lvl1)::getToolTip,                            \
         boost::python::return_value_policy<boost::python::copy_const_reference>(), \
         "retrieve object tool tip")                                                \
    .def("requestCancellation", &core::BaseAction::requestCancellation, "action execution cancellation request")\
    .def("waitForCompletion", &core::BaseAction::waitForCompletion, "method allowing to wait for execution end")\
    .def("getStatus", &core::BaseAction::getStatus, "retrieve action result")\
    .def("getActionResult", &core::BaseAction::getActionResult, "check for action execution status")\
    .def("getFullInfoStr", &BOOST_PP_CAT(processorName, Lvl1)::getFullInfoStr, "retrieve full processor informations string including attributes tooltip, rules and initialization information")\
    .def("isProgressAvailable", &BOOST_PP_CAT(processorName, Lvl1)::isProgressAvailable, "method indicating if the processor progression is available")\
    .def("getProgressAvailability", &BOOST_PP_CAT(processorName, Lvl1)::getProgressAvailability, "method indicating if the processor progression is available")\
    .def("getProgress", &ipsdk::processor::BaseAsyncProcessor::getProgress, "retrieve processor progress")\
    .def("getCurIterIdx", &ipsdk::processor::BaseAsyncProcessor::getCurIterIdx, "Returns the index of current iteration")\
    .def("getTotalNbIterations", &BOOST_PP_CAT(processorName, Lvl1)::getTotalNbIterations, "method indicating the processor total number of iterations. Returns 0 for unknown number of iterations (ITER_ASYNC and REP_ASYNC)")\
    .def("getFullActionDuration", &core::BaseAction::getFullActionDuration, " retrieve elasped execution duration between call to run and termination");\
    IPSDK_REGISTER_PROCESSOR_TO_PYTHON_BOOST_WORKAROUND(processorName)


#endif // __PYIPSDKBASE_PYTHONPROCESSORMACROS_H__