i_rolling_statistics_rule_data

Module for IRollingStatisticsRuleData interface

!!! interfaces IRollingStatisticsRuleData

IRollingStatisticsRuleData (IRuleData, ABC)

Data for a RollingStatisticsRule

Source code in api/i_rolling_statistics_rule_data.py

class IRollingStatisticsRuleData(IRuleData, ABC):
    """Data for a RollingStatisticsRule"""

    @property
    @abstractmethod
    def input_variable(self) -> str:
        """Name of the input variable"""

    @property
    @abstractmethod
    def operation(self) -> TimeOperationType:
        """Operation type"""

    @property
    @abstractmethod
    def percentile_value(self) -> float:
        """Operation parameter"""

    @property
    @abstractmethod
    def time_scale(self) -> str:
        """Time scale"""

    @property
    @abstractmethod
    def period(self) -> float:
        """Period"""

input_variable: str property readonly

Name of the input variable

operation: TimeOperationType property readonly

Operation type

percentile_value: float property readonly

Operation parameter

period: float property readonly

Period

time_scale: str property readonly

Time scale