debounce.hpp

Go to the documentation of this file.

/*
    Copyright 2005-2007 Adobe Systems Incorporated
    Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
    or a copy at http://stlab.adobe.com/licenses.html)
*/

/*************************************************************************************************/

#ifndef ADOBE_DEBOUNCE_HPP
#define ADOBE_DEBOUNCE_HPP

/*************************************************************************************************/

#include <adobe/config.hpp>

#include <boost/function.hpp>

#include <adobe/any_regular.hpp>

/*************************************************************************************************/

namespace adobe {

/*************************************************************************************************/

template <typename ModeType>    
class debounce_t
{
public:
    typedef ModeType                                  model_type;
    typedef boost::function<void (const model_type&)> proc_type;

    debounce_t() :
        type_2_debounce_m(false),
        first_time_m(true)
    { }

    template <typename UnaryFunction1, typename UnaryFunction2>
    debounce_t(const UnaryFunction1& set_model_proc, const UnaryFunction2& monitor_model_proc) :
        set_model_m(set_model_proc),
        monitor_model_m(monitor_model_proc),
        type_2_debounce_m(false),
        first_time_m(true)
    { }

    void set_model_value(const model_type& from_controller)
    {
        assert (set_model_m);

        if (first_time_m)
            type_2_debounce_m = false;

        if (type_2_debounce_m)
        {
            type_2_debounce_m = false;

            return;
        }

        type_1_debounce_m = from_controller;

        set_model_m(from_controller);

        first_time_m = false;
    }

    void display(const model_type& new_value)
    {
        assert (monitor_model_m);

        if (new_value == type_1_debounce_m)
            return;
        
        type_1_debounce_m = new_value;
        type_2_debounce_m = true;

        monitor_model_m(new_value);
    }

    void reset_set_model_proc(const proc_type& proc)
    { type_1_debounce_m = model_type(); set_model_m = proc; }

    void reset_monitor_model_proc(const proc_type& proc)
    { type_2_debounce_m = false; monitor_model_m = proc; }

    const model_type& last() const
    { return type_1_debounce_m; }

    bool is_set_model_proc_installed() const
    { return set_model_m; }

    bool is_monitor_model_proc_installed() const
    { return monitor_model_m; }

private:
    proc_type  set_model_m;
    proc_type  monitor_model_m;
    model_type type_1_debounce_m;
    bool       type_2_debounce_m;
    bool       first_time_m;
};

/*************************************************************************************************/

} // namespace adobe

/*************************************************************************************************/

// ADOBE_DEBOUNCE_HPP
#endif

/*************************************************************************************************/