Source code for prolint.config.enums

"""ProLint enumeration types.

This module provides enum classes for time units and normalization methods.
"""

from enum import Enum



[docs]
class TimeUnit(str, Enum):
    """Time unit options for contact duration analysis.

    Attributes
    ----------
    FEMTOSECOND : str
        Femtoseconds ("fs").
    PICOSECOND : str
        Picoseconds ("ps").
    NANOSECOND : str
        Nanoseconds ("ns").
    MICROSECOND : str
        Microseconds ("us").
    MILLISECOND : str
        Milliseconds ("ms").
    SECOND : str
        Seconds ("s").
    """


[docs]
    FEMTOSECOND = "fs"


[docs]
    PICOSECOND = "ps"


[docs]
    NANOSECOND = "ns"


[docs]
    MICROSECOND = "us"


[docs]
    MILLISECOND = "ms"


[docs]
    SECOND = "s"


    def __str__(self) -> str:
        """Return the string value of the enum."""
        return self.value




[docs]
class NormalizationMethod(str, Enum):
    """Normalization methods for contact durations.

    Attributes
    ----------
    COUNTS : str
        Report durations as frame counts ("counts").
    ACTUAL_TIME : str
        Report durations in time units ("actual_time").
    """


[docs]
    COUNTS = "counts"


[docs]
    ACTUAL_TIME = "actual_time"


    def __str__(self) -> str:
        """Return the string value of the enum."""
        return self.value