peak_common_ipipeline.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common/detail/peak_common_defines.hpp>
#include <peak_common/pipeline/modules/peak_common_imodule.hpp>
#include <peak_common/types/peak_common_any.hpp>
 
#include <memory>
#include <string>
#include <vector>

 
namespace peak
{
namespace pipeline
{

class IPipeline
{
public:
    virtual ~IPipeline() = default;

    virtual void ExportSettingsToFile(const std::string& filePath) const = 0;

    virtual void ImportSettingsFromFile(const std::string& filePath) = 0;

    PEAK_COMMON_NO_DISCARD virtual std::string ExportSettingsToString() const = 0;

    virtual void ImportSettingsFromString(const std::string& settings) = 0;

    virtual void ResetToDefault() = 0;

    PEAK_COMMON_NO_DISCARD virtual peak::common::Any Process(const peak::common::Any& input) const = 0;

    virtual peak::common::Any operator<<(const peak::common::Any& input) = 0;

    PEAK_COMMON_NO_DISCARD virtual const char* GetType() const = 0;
 
protected:
    PEAK_COMMON_NO_DISCARD virtual std::vector<std::shared_ptr<modules::IModule>> GetModules() const = 0;
};
 
} // namespace pipeline 
} // namespace peak