imodule.py

Go to the documentation of this file.

from __future__ import annotations
 
from abc import abstractmethod
from typing import Any
 
from ids_peak_common.serialization import ISerializable
 
 
class IModule(ISerializable):
    """!
    @brief
    Interface for a module used within a pipeline.
 
    Modules must support enabling/disabling, processing input, and serialization.
 
    @since ids_peak_common 1.1
    @ingroup ids_peak_common_python_pipeline_modules
    """
 
    @property
    @abstractmethod
    def enabled(self) -> bool:
        """!
        @brief
        Gets whether the module is currently enabled.
 
        @return True if the module is enabled, False otherwise.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @enabled.setter
    @abstractmethod
    def enabled(self, value: bool) -> None:
        """!
        @brief
        Sets the enabled state of the module.
 
        @param value: True to enable the module, False to disable it.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @property
    @abstractmethod
    def type(self) -> str:
        """!
        @brief
        Returns the type identifier of the module.
 
        This should be a unique string identifying the specific implementation
        of the module.
 
        @return A string identifying the module type.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @abstractmethod
    def process(self, data: Any) -> Any:
        """!
        @brief
        Processes input data and returns the result.
 
        This function is called by the pipeline to process a unit of data.
 
        @param data: The input data to be processed.
 
        @return The processed input.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @abstractmethod
    def reset_to_default(self) -> None:
        """!
        @brief
        Resets the module to its default state. The enabled state is not reset.
 
        @since ids_peak_common 1.1
        """
        pass