IModule Class Reference

#include <peak_common/pipeline/modules/peak_common_imodule.hpp>

Inheritance diagram for IModule:

Public Member Functions
	~IModule () override=default
virtual void	SetEnabled (bool enabled)=0
	Sets the enabled state of the module.
virtual bool	IsEnabled () const =0
	Checks whether the module is currently enabled.
virtual const char *	GetType () const =0
	Returns the type identifier of the module.
virtual peak::common::Any	Process (const peak::common::Any &input) const =0
	Processes input data and returns the result.
virtual void	ResetToDefault ()=0
	Resets the module to its default state. The enabled state is not reset.
virtual void	Serialize (IArchive &archive) const =0
	Serializes the current object into the provided archive.
virtual void	Deserialize (const IArchive &archive)=0
	Deserializes the object's state from the provided archive.

Detailed Description

Interface for a module used within a pipeline.

Defines the required functions that must be implemented by any module participating in the pipeline. Modules must support enabling/disabling, processing input, and serialization.

Since

ids_peak_common 1.0

Constructor & Destructor Documentation

~IModule()

~IModule ( )

overridedefault

Member Function Documentation

Deserialize()

virtual void Deserialize ( const IArchive & archive )

pure virtualinherited

Deserializes the object's state from the provided archive.

This method reads data from the given peak::common::serialization::IArchive and reconstructs the internal state of the object.

Parameters

archive

The archive from which to read the object's data.

Implemented in ColorCorrectionMatrix, ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

GetType()

virtual const char * GetType ( ) const

pure virtual

Returns the type identifier of the module.

This should be a unique string identifying the specific implementation of the module.

Returns

A null-terminated string identifying the module type.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

IsEnabled()

virtual bool IsEnabled ( ) const

pure virtual

Checks whether the module is currently enabled.

Returns

True if the module is enabled, false otherwise.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

Process()

virtual peak::common::Any Process ( const peak::common::Any & input ) const

pure virtual

Processes input data and returns the result.

This function is called by the pipeline to process a unit of data.

Parameters

input

The input data to be processed.

Returns

The processed input.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

ResetToDefault()

virtual void ResetToDefault ( )

pure virtual

Resets the module to its default state. The enabled state is not reset.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

Serialize()

virtual void Serialize ( IArchive & archive ) const

pure virtualinherited

Serializes the current object into the provided archive.

This method writes the internal state of the object into the given peak::common::serialization::IArchive so that it can later be reconstructed using Deserialize().

Parameters

archive

The archive to which the object's data will be written.

Implemented in ColorCorrectionMatrix, ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

SetEnabled()

virtual void SetEnabled ( bool enabled )

pure virtual

Sets the enabled state of the module.

Parameters

enabled

True to enable the module, false to disable it.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.