KisSignalCompressorWithParam< T > Class Template Reference

#include <kis_signal_compressor_with_param.h>

Public Types
using	CallbackFunction = std::function<void (T)>

Public Member Functions
bool	isActive () const
	KisSignalCompressorWithParam (int delay, CallbackFunction function, KisSignalCompressor::Mode mode=KisSignalCompressor::FIRST_ACTIVE)
void	setDelay (int value)
void	start (T param)
void	stop ()
	~KisSignalCompressorWithParam ()

Private Member Functions
void	fakeSlotTimeout ()

Private Attributes
KisSignalCompressor	m_compressor
T	m_currentParamValue
CallbackFunction	m_function
QScopedPointer< SignalToFunctionProxy >	m_signalProxy

Detailed Description

template<typename T>
class KisSignalCompressorWithParam< T >

A special class for deferring and compressing events with one parameter of type T. This works like KisSignalCompressor but can handle events with one parameter. Due to limitation of the Qt this doesn't allow signal/slots, so it uses std::function instead.

In the end (after a timeout) the latest param value is returned to the callback.

   Usage:

   \code{.cpp}

   using namespace std::placeholders; // For _1 placeholder

   // prepare the callback function
   std::function<void (qreal)> callback(
       std::bind(&LutDockerDock::setCurrentExposureImpl, this, _1));

   // Create the compressor object
   KisSignalCompressorWithParam<qreal> compressor(40, callback);

   // When event comes:
   compressor.start(0.123456);

   \endcode

Definition at line 111 of file kis_signal_compressor_with_param.h.

Member Typedef Documentation

CallbackFunction

template<typename T >

using KisSignalCompressorWithParam< T >::CallbackFunction = std::function<void (T)>

Definition at line 114 of file kis_signal_compressor_with_param.h.

Constructor & Destructor Documentation

KisSignalCompressorWithParam()

template<typename T >

KisSignalCompressorWithParam< T >::KisSignalCompressorWithParam ( int delay, CallbackFunction function, KisSignalCompressor::Mode mode = KisSignalCompressor::FIRST_ACTIVE )

inline

Definition at line 117 of file kis_signal_compressor_with_param.h.

        : m_compressor(delay, mode),
          m_function(function)
    {
        std::function<void ()> callback(
            std::bind(&KisSignalCompressorWithParam<T>::fakeSlotTimeout, this));
        m_signalProxy.reset(new SignalToFunctionProxy(callback));
 
        m_compressor.connect(&m_compressor, SIGNAL(timeout()), m_signalProxy.data(), SLOT(start()));
    }

References KisSignalCompressorWithParam< T >::m_compressor, KisSignalCompressorWithParam< T >::m_signalProxy, KisSignalCompressorWithParam< T >::start(), and void().

~KisSignalCompressorWithParam()

template<typename T >

KisSignalCompressorWithParam< T >::~KisSignalCompressorWithParam ( )

inline

Definition at line 128 of file kis_signal_compressor_with_param.h.

    {
    }

Member Function Documentation

fakeSlotTimeout()

template<typename T >

void KisSignalCompressorWithParam< T >::fakeSlotTimeout ( )

inlineprivate

Definition at line 150 of file kis_signal_compressor_with_param.h.

                           {
        m_function(m_currentParamValue);
    }

References KisSignalCompressorWithParam< T >::m_currentParamValue, and KisSignalCompressorWithParam< T >::m_function.

isActive()

template<typename T >

bool KisSignalCompressorWithParam< T >::isActive ( ) const

inline

Definition at line 141 of file kis_signal_compressor_with_param.h.

                          {
        return m_compressor.isActive();
    }

References KisSignalCompressor::isActive(), and KisSignalCompressorWithParam< T >::m_compressor.

setDelay()

template<typename T >

void KisSignalCompressorWithParam< T >::setDelay ( int value )

inline

Definition at line 145 of file kis_signal_compressor_with_param.h.

                             {
        m_compressor.setDelay(value);
    }

References KisSignalCompressorWithParam< T >::m_compressor, KisSignalCompressor::setDelay(), and value().

start()

template<typename T >

void KisSignalCompressorWithParam< T >::start ( T param )

inline

Definition at line 132 of file kis_signal_compressor_with_param.h.

                        {
        m_currentParamValue = param;
        m_compressor.start();
    }

References KisSignalCompressorWithParam< T >::m_compressor, KisSignalCompressorWithParam< T >::m_currentParamValue, and KisSignalCompressor::start().

stop()

template<typename T >

void KisSignalCompressorWithParam< T >::stop ( )

inline

Definition at line 137 of file kis_signal_compressor_with_param.h.

                {
        m_compressor.stop();
    }

References KisSignalCompressorWithParam< T >::m_compressor, and KisSignalCompressor::stop().

Member Data Documentation

m_compressor

template<typename T >

KisSignalCompressor KisSignalCompressorWithParam< T >::m_compressor

private

Definition at line 155 of file kis_signal_compressor_with_param.h.

m_currentParamValue

template<typename T >

T KisSignalCompressorWithParam< T >::m_currentParamValue

private

Definition at line 158 of file kis_signal_compressor_with_param.h.

m_function

template<typename T >

CallbackFunction KisSignalCompressorWithParam< T >::m_function

private

Definition at line 156 of file kis_signal_compressor_with_param.h.

m_signalProxy

template<typename T >

QScopedPointer<SignalToFunctionProxy> KisSignalCompressorWithParam< T >::m_signalProxy

private

Definition at line 157 of file kis_signal_compressor_with_param.h.

---

The documentation for this class was generated from the following file:

• libs/global/kis_signal_compressor_with_param.h