IPipeline Interface Reference

Inheritance diagram for IPipeline:

Public Member Functions
void	ExportSettingsToFile (string filePath)
	Saves the current settings of the pipeline and its modules to a file.
void	ImportSettingsFromFile (string filePath)
	Loads the settings of the pipeline and its modules from a file.
string	ExportSettingsToString ()
	Returns the current settings of the pipeline and its modules as a string.
void	ImportSettingsFromString (string settings)
	Loads settings for the pipeline and its modules from a string.
void	ResetToDefault ()
	Resets the pipeline and its modules to their default state.
object	Process (object input)
	Processes the input through all pipeline modules and returns the result.

Properties
string	TypeId [get]
	The type identifier of the pipeline.

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 method is called sequentially, and the final result is returned.

Since

IDSImaging.Peak.Common 1.3

Member Function Documentation

ExportSettingsToFile()

void ExportSettingsToFile

(

string

filePath

)

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.

Implemented in PipelineBase.

ExportSettingsToString()

string ExportSettingsToString

(

)

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

Returns

A string representation of the pipeline settings.

Implemented in PipelineBase, and DefaultPipeline.

ImportSettingsFromFile()

void ImportSettingsFromFile

(

string

filePath

)

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

Parameters

filePath

Path to the file from which settings should be loaded.

Implemented in PipelineBase.

ImportSettingsFromString()

void ImportSettingsFromString

(

string

settings

)

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

Parameters

settings

String containing serialized pipeline settings.

Implemented in PipelineBase, and DefaultPipeline.

Process()

object Process

(

object

input

)

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.

Implemented in PipelineBase, and DefaultPipeline.

ResetToDefault()

void ResetToDefault

(

)

Resets the pipeline and its modules to their default state.

Implemented in PipelineBase, and DefaultPipeline.

Property Documentation

TypeId

string TypeId

get

The type identifier of the pipeline.

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

Implemented in PipelineBase, and DefaultPipeline.