peak::pipeline::IPipeline Class Reference

Interface defining the structure and behavior of a processing pipeline. More...

#include <peak_common/pipeline/peak_common_ipipeline.hpp>

Inheritance diagram for peak::pipeline::IPipeline:

Public Member Functions
virtual	~IPipeline ()=default
virtual void	ExportSettingsToFile (const std::string &filePath) const =0
	Saves the current settings of the pipeline and its modules to a file.
virtual void	ImportSettingsFromFile (const std::string &filePath)=0
	Loads the settings of the pipeline and its modules from a file.
virtual PEAK_COMMON_NO_DISCARD std::string	ExportSettingsToString () const =0
	Returns the current settings of the pipeline and its modules as a string.
virtual void	ImportSettingsFromString (const std::string &settings)=0
	Loads settings for the pipeline and its modules from a string.
virtual void	ResetToDefault ()=0
	Resets the pipeline and its modules to their default state.
virtual PEAK_COMMON_NO_DISCARD peak::common::Any	Process (const peak::common::Any &input) const =0
	Processes the input through all pipeline modules and returns the result.
virtual peak::common::Any	operator<< (const peak::common::Any &input)=0
	Convenience operator for processing input using the pipeline.
virtual PEAK_COMMON_NO_DISCARD const char *	GetType () const =0
	Returns the type identifier of the pipeline.

Protected Member Functions
virtual PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< modules::IModule > >	GetModules () const =0
	Retrieves the list of all modules in the pipeline, in execution order.

Detailed Description

Interface defining the structure and behavior of a processing pipeline.

A pipeline is composed of multiple modules chained together in a defined order. When an input is processed, each module's Process function is called sequentially, and the final result is returned.

Since

ids_peak_common 1.0

Constructor & Destructor Documentation

~IPipeline()

virtual peak::pipeline::IPipeline::~IPipeline ( )

virtualdefault

Member Function Documentation

ExportSettingsToFile()

virtual void peak::pipeline::IPipeline::ExportSettingsToFile ( const std::string & filePath ) const

pure virtual

Saves the current settings of the pipeline and its modules to a file.

Parameters

filePath

Path to the file where the settings should be saved.

Since

ids_peak_common 1.0

Implemented in peak::pipeline::PipelineBase.

ExportSettingsToString()

virtual PEAK_COMMON_NO_DISCARD std::string peak::pipeline::IPipeline::ExportSettingsToString ( ) const

pure virtual

Returns the current settings of the pipeline and its modules as a string.

Returns

A string representation of the pipeline settings.

Since

ids_peak_common 1.0

GetModules()

virtual PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< modules::IModule > > peak::pipeline::IPipeline::GetModules ( ) const

protectedpure virtual

Retrieves the list of all modules in the pipeline, in execution order.

Returns

A vector of shared pointers to the modules.

Since

ids_peak_common 1.0

GetType()

virtual PEAK_COMMON_NO_DISCARD const char * peak::pipeline::IPipeline::GetType ( ) const

pure virtual

Returns the type identifier of the pipeline.

This is a unique string used to identify the specific pipeline implementation.

Returns

A null-terminated string representing the pipeline type.

Since

ids_peak_common 1.0

ImportSettingsFromFile()

virtual void peak::pipeline::IPipeline::ImportSettingsFromFile ( const std::string & filePath )

pure virtual

Loads the settings of the pipeline and its modules from a file.

Parameters

filePath

Path to the file from which settings should be loaded.

Since

ids_peak_common 1.0

Implemented in peak::pipeline::PipelineBase.

ImportSettingsFromString()

virtual void peak::pipeline::IPipeline::ImportSettingsFromString ( const std::string & settings )

pure virtual

Loads settings for the pipeline and its modules from a string.

Parameters

settings

String containing serialized pipeline settings.

Since

ids_peak_common 1.0

operator<<()

virtual peak::common::Any peak::pipeline::IPipeline::operator<< ( const peak::common::Any & input )

pure virtual

Convenience operator for processing input using the pipeline.

Equivalent to calling Process(input).

Parameters

input

The input to process.

Returns

The processed input.

Since

ids_peak_common 1.0

Implemented in peak::pipeline::PipelineBase.

Process()

virtual PEAK_COMMON_NO_DISCARD peak::common::Any peak::pipeline::IPipeline::Process ( const peak::common::Any & input ) const

pure virtual

Processes the input through all pipeline modules and returns the result.

The input is passed through each module in sequence.

Parameters

input

The input to process.

Returns

The processed input.

Since

ids_peak_common 1.0

Implemented in peak::pipeline::PipelineBase.

ResetToDefault()

virtual void peak::pipeline::IPipeline::ResetToDefault ( )

pure virtual

Resets the pipeline and its modules to their default state.

Since

ids_peak_common 1.0

---

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

• peak_common/pipeline/peak_common_ipipeline.hpp