Inheritance diagram for IModule:

Public Member Functions
bool	enabled (self)
	Gets whether the module is currently enabled.

None	enabled (self, bool value)
	Sets the enabled state of the module.

str	type (self)
	Returns the type identifier of the module.

Any	process (self, Any data)
	Processes input data and returns the result.

None	reset_to_default (self)
	Resets the module to its default state.

Detailed Description

Interface for a module used within a pipeline.

Modules must support enabling/disabling, processing input, and serialization.

Since: ids_peak_common 1.1

Definition at line 9 of file imodule.py.

Member Function Documentation

◆ enabled() [1/2]

bool enabled ( self )

Gets whether the module is currently enabled.

Returns: True if the module is enabled, False otherwise.

Since: ids_peak_common 1.1

Definition at line 22 of file imodule.py.

◆ enabled() [2/2]

None enabled	(		self,
		bool	value )

Sets the enabled state of the module.

Parameters

value True to enable the module, False to disable it.

Since: ids_peak_common 1.1

Definition at line 35 of file imodule.py.

◆ process()

Any process	(		self,
		Any	data )

Processes input data and returns the result.

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

Parameters

data	The input data to be processed.

Returns: The processed input.

Since: ids_peak_common 1.1

Definition at line 63 of file imodule.py.

◆ reset_to_default()

None reset_to_default ( self )

Resets the module to its default state.

The enabled state is not reset.

Since: ids_peak_common 1.1

Definition at line 79 of file imodule.py.

◆ type()

str type ( self )

Returns the type identifier of the module.

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

Returns: A string identifying the module type.

Since: ids_peak_common 1.1

Definition at line 48 of file imodule.py.