PythonProcessorMacros.h File Reference

Macros allowing to handle ipsdk image processing library processor to python wrapping. More...

#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>

Go to the source code of this file.

Macros
#define	IPSDK_REGISTER_PROCESSOR_TO_PYTHON_BOOST_WORKAROUND(processorName)
	macro to avoid link errors generated by VC2015 SP3 when IPSDK_REGISTER_PROCESSOR_TO_PYTHON is used
#define	IPSDK_REGISTER_PROCESSOR_TO_PYTHON(processorName)
	macro allowing to register an IPSDK image processing library processor to python More...

Detailed Description

Macros allowing to handle ipsdk image processing library processor to python wrapping.

Author

E. Noirfalise

Date

2015/12/10

Copyright

2015 Reactiv'IP, all right reserved.

Macro Definition Documentation

IPSDK_REGISTER_PROCESSOR_TO_PYTHON

#define IPSDK_REGISTER_PROCESSOR_TO_PYTHON

(

processorName

)

Value:

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)

macro allowing to register an IPSDK image processing library processor to python