PipelineBase Class Reference

Inheritance diagram for PipelineBase:

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

Properties
string	TypeId [get]
	The type identifier of the pipeline.This is a unique string used to identify the specific pipeline implementation.

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

IDSImaging.Peak.Common 1.3

Member Function Documentation

ExportSettingsToFile()

virtual void ExportSettingsToFile ( string filePath )

inlinevirtual

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

This base implementation calls ExportSettingsToString and writes the resulting string to the specified filepath.

Parameters

filePath

Path to the file where the settings should be saved.

Implements IPipeline.

ExportSettingsToString()

string ExportSettingsToString ( )

abstract

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

Returns

A string representation of the pipeline settings.

Implements IPipeline.

ImportSettingsFromFile()

virtual void ImportSettingsFromFile ( string filePath )

inlinevirtual

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

This base implementation reads the file contents and passes them to ImportSettingsFromString to restore the pipeline state.

Parameters

filePath

Path to the file from which settings should be loaded.

Implements IPipeline.

ImportSettingsFromString()

void ImportSettingsFromString ( string settings )

abstract

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

Parameters

settings

String containing serialized pipeline settings.

Implements IPipeline.

Process()

virtual object Process ( object input )

inlinevirtual

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

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

Parameters

input

The input to process.

Returns

The processed input.

Implements IPipeline.

Reimplemented in DefaultPipeline.

ResetToDefault()

void ResetToDefault ( )

abstract

Resets the pipeline and its modules to their default state.

Implements IPipeline.

Property Documentation

TypeId

string TypeId

getabstract

The type identifier of the pipeline.This is a unique string used to identify the specific pipeline implementation.

Implements IPipeline.