IPipeline Class Reference

Inheritance diagram for IPipeline:

Public Member Functions
None	export_settings_to_file (self, str file_path)
	Saves the current settings of the pipeline and its modules to a file.
None	import_settings_from_file (self, str file_path)
	Loads the settings of the pipeline and its modules from a file.
str	export_settings_to_string (self)
	Returns the current settings of the pipeline and its modules as a string.
None	import_settings_from_string (self, str settings)
	Loads settings for the pipeline and its modules from a string.
None	reset_to_default (self)
	Resets the pipeline and its modules to their default state.
Any	process (self, Any data)
	Processes the input data through all pipeline modules and returns the result.
str	type (self)
	Returns the type identifier of the pipeline.

Protected Member Functions
Sequence[IModule]	_modules (self)
	Retrieves the sequence 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.1

Definition at line 9 of file ipipeline.py.

Member Function Documentation

_modules()

Sequence[IModule] _modules ( self )

protected

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

Returns

A sequence of modules.

Reimplemented in DefaultPipeline.

Definition at line 99 of file ipipeline.py.

export_settings_to_file()

None export_settings_to_file	(		self,
		str	file_path )

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

Parameters

file_path

Path to the file where the settings should be saved.

Reimplemented in PipelineBase.

Definition at line 23 of file ipipeline.py.

export_settings_to_string()

str export_settings_to_string

(

self

)

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

Returns

A string representation of the pipeline settings.

Reimplemented in DefaultPipeline.

Definition at line 43 of file ipipeline.py.

import_settings_from_file()

None import_settings_from_file	(		self,
		str	file_path )

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

Parameters

file_path

Path to the file from which settings should be loaded.

Reimplemented in PipelineBase.

Definition at line 33 of file ipipeline.py.

import_settings_from_string()

None import_settings_from_string	(		self,
		str	settings )

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

Parameters

settings

String containing serialized pipeline settings.

Reimplemented in DefaultPipeline.

Definition at line 53 of file ipipeline.py.

process()

Any process	(		self,
		Any	data )

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

The input data is passed through each module in sequence.

Parameters

data	The input data to process.

Returns

The processed input.

Reimplemented in PipelineBase, and DefaultPipeline.

Definition at line 71 of file ipipeline.py.

reset_to_default()

None reset_to_default

(

self

)

Resets the pipeline and its modules to their default state.

Reimplemented in DefaultPipeline.

Definition at line 63 of file ipipeline.py.

type()

str type

(

self

)

Returns the type identifier of the pipeline.

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

Returns

A string representing the pipeline type.

Reimplemented in DefaultPipeline.

Definition at line 86 of file ipipeline.py.