Skip to content

step_function_data

Module for StepFunctionRuleData class

!!! classes StepFunctionRuleData

StepFunctionRuleData (IStepFunctionRuleData, RuleData)

Class for storing data related to step function rule

Source code in entities/step_function_data.py
class StepFunctionRuleData(IStepFunctionRuleData, RuleData):
    """Class for storing data related to step function rule"""

    def __init__(
        self,
        name: str,
        limits: List[float],
        responses: List[float],
        input_variable: str,
    ):
        super().__init__(name)
        self._input_variable = input_variable
        self._limits = limits
        self._responses = responses

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

    @property
    def limits(self) -> List[float]:
        """Limits of the interval definition for the step function rule"""
        return self._limits

    @property
    def responses(self) -> List[float]:
        """Step wise responses corresponding to each interval defined by the limits"""
        return self._responses

input_variable: str property readonly

Name of the input variable

limits: List[float] property readonly

Limits of the interval definition for the step function rule

responses: List[float] property readonly

Step wise responses corresponding to each interval defined by the limits