roviz_item.h

#ifndef PORTABLEITEM_H
#define PORTABLEITEM_H

// TODO If one thread alone can't handle all data, spawn more threads
// to already start processing the next images as soon as they arrive.

#include <string>
#include <memory>
#include <functional>
#include <mutex>
#include "core/export_handling.h"
#include "core/input.h"
#include "core/output.h"
#include "core/trim.h"
#include "core/roviz_item_p.h"
#include "config/config.h"
#include "core/template_decl.h"
#include "streams/stream_object.h"

// Include the appropriate base class
#include ROVIZ_BASE_INCLUDE

class ROVIZ_EXPORT RovizItem : public RovizItemBase
{
#if ROVIZ_BACKEND == ROVIZ_BACKEND_Dev
    // The moc won't allow a portable name
    Q_OBJECT
#endif

public:
    explicit RovizItem(std::string type_name);
    virtual ~RovizItem();

    virtual void starting(void);

    virtual void thread(void) = 0;

    void stop(void) override;

    virtual void stopped(void);

    template<class T>
    Input<T> addInput(std::string name);

    template<class T>
    Output<T> addOutput(std::string name);

    bool waitForCond(std::function<bool (void)> cond);

    bool waitFor(std::function<bool (void)> cond);

    bool wait(void);

    bool running(void) const override;

    void wake(void) const;

    std::mutex &mutex(void) const;

    Trim addTrim(std::string name, double default_value, double min, double max, std::function<void (double)> notifier_func);

    Trim addTrim(std::string name, double default_value, double min, double max, bool logarithmic);

    Trim addTrim(std::string name, double default_value, double min, double max, int steps, std::function<void (double)> notifier_func);

    Trim addTrim(std::string name, double default_value, double min, double max, int steps = 0, bool logarithmic = false, std::function<void (double)> notifier_func = [](double){});

    Trim addTrim(std::string name, double default_value, double min, double max, double step_size, std::function<void (double)> notifier_func = [](double){});

    template<class T>
    Config<T> addConfig(const std::string &name, const typename ConfigStorageType<T>::type &default_value, int min, int max, bool restart_when_changed = false);

    template<class T>
    Config<T> addConfig(const std::string &name, const typename ConfigStorageType<T>::type &default_value, double min, double max, bool restart_when_changed = false);

    template<class T>
    Config<T> addConfig(const std::string &name, const typename ConfigStorageType<T>::type &default_value, std::function<bool (std::string&)> checker = [](std::string &){return true;}, bool restart_when_changed = false);

    template<class T>
    Config<T> addConfig(const std::string &name, const typename ConfigStorageType<T>::type &default_index, const std::list<std::string> &possibilities, bool restart_when_changed = false);

    template<class T>
    Config<T> addConfig(const std::string &name, const typename ConfigStorageType<T>::type &default_value, bool restart_when_changed = false);

    template<class T>
    Config<T> addConfig(const std::string &name, const typename ConfigStorageType<T>::type &default_value, enum FilePath::Mode file_mode, const std::string &filter, bool restart_when_changed = false);

private:
    std::unique_ptr<RovizItemPrivate> _this;


    void start(void) override;

    void pause(void) override;

    void join(void) override;

    void unpause(void) override;
};

#endif // PORTABLEITEM_H