IDS peak AFL v2.1.0
Loading...
Searching...
No Matches
peak_common_ipipeline.hpp
Go to the documentation of this file.
1
5
6#pragma once
7
11
12#include <memory>
13#include <string>
14#include <vector>
15
31
32namespace peak
33{
34namespace pipeline
35{
36
49{
50public:
51 virtual ~IPipeline() = default;
52
60 virtual void ExportSettingsToFile(const std::string& filePath) const = 0;
61
69 virtual void ImportSettingsFromFile(const std::string& filePath) = 0;
70
78 PEAK_COMMON_NO_DISCARD virtual std::string ExportSettingsToString() const = 0;
79
87 virtual void ImportSettingsFromString(const std::string& settings) = 0;
88
94 virtual void ResetToDefault() = 0;
95
107 PEAK_COMMON_NO_DISCARD virtual peak::common::Any Process(const peak::common::Any& input) const = 0;
108
121
131 PEAK_COMMON_NO_DISCARD virtual const char* GetType() const = 0;
132
133protected:
141 PEAK_COMMON_NO_DISCARD virtual std::vector<std::shared_ptr<modules::IModule>> GetModules() const = 0;
142};
143
144} // namespace pipeline
145} // namespace peak
A type-erased container for any copyable value.
Definition peak_common_any.hpp:31
Interface defining the structure and behavior of a processing pipeline.
Definition peak_common_ipipeline.hpp:49
virtual std::vector< std::shared_ptr< modules::IModule > > GetModules() const =0
Retrieves the list of all modules in the pipeline, in execution order.
virtual void ImportSettingsFromFile(const std::string &filePath)=0
Loads the settings of the pipeline and its modules from a file.
virtual std::string ExportSettingsToString() const =0
Returns the current settings of the pipeline and its modules as a string.
virtual peak::common::Any Process(const peak::common::Any &input) const =0
Processes the input through all pipeline modules and returns the result.
virtual void ResetToDefault()=0
Resets the pipeline and its modules to their default state.
virtual peak::common::Any operator<<(const peak::common::Any &input)=0
Convenience operator for processing input using the pipeline.
virtual void ImportSettingsFromString(const std::string &settings)=0
Loads settings for the pipeline and its modules from a string.
virtual const char * GetType() const =0
Returns the type identifier of the pipeline.
virtual void ExportSettingsToFile(const std::string &filePath) const =0
Saves the current settings of the pipeline and its modules to a file.
Interfaces and implementations for defining and controlling data processing pipelines.
Definition peak_afl_generic_auto_brightness.hpp:33