Source code for otx.api.configuration.ui_rules.types

"""This module contains the types used for specifying UI interaction with the configuration."""
# Copyright (C) 2021-2022 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
#


from enum import Enum, auto




class Operator(Enum):
    """This Enum represents the allowed operators for use in constructing UI rules for configuration parameters.

    These operators can be used to disable a configuration parameter, conditional on the value of another parameter.
    """

    NOT = auto()
    EQUAL_TO = auto()
    LESS_THAN = auto()
    GREATER_THAN = auto()
    AND = auto()
    OR = auto()
    XOR = auto()

    def __str__(self):
        """Retrieves the string representation of an instance of the Enum."""
        return self.name





class Action(Enum):
    """This Enum represents the allowed actions that UI rules can dictate on configuration parameters."""

    HIDE = auto()
    SHOW = auto()
    ENABLE_EDITING = auto()
    DISABLE_EDITING = auto()

    def __str__(self):
        """Retrieves the string representation of an instance of the Enum."""
        return self.name