PipelineBase Class Reference

Inheritance diagram for PipelineBase:

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.
Any	process (self, Any data)
	Processes the input data through all pipeline modules and returns the result.

Protected Attributes
	_modules

Detailed Description

Base class for implementing a custom pipeline.

Provides a partial implementation of the IPipeline interface. Can be used as a foundation for creating custom pipeline behavior.

Since

ids_peak_common 1.1

Member Function Documentation

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.

This base implementation calls export_settings_to_string() and writes the resulting string to the specified file path.

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.

This base implementation reads the file contents and passes them to import_settings_from_string() to restore the pipeline state.

process()

Any process	(		self,
		Any	data )

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

This base implementation iterates over all modules returned by get_modules(), calling each module's process() method in sequence and passing the result along.

Parameters

data	The input data to process.

Returns

The processed input.

Field Documentation

_modules

_modules

protected