Source code for ska_pst.testutils.common.quality_attribute_mapping

# -*- coding: utf-8 -*-
#
# This file is part of the SKA PST project
#
# Distributed under the terms of the BSD 3-clause new license.
# See LICENSE for more info.

"""Module defining a data class to map signal quality attributes to UDP Gen and TANGO attributes."""

from __future__ import annotations

__all__ = [
    "QualityAttributeMapping",
]

import dataclasses


[docs]@dataclasses.dataclass(kw_only=True, frozen=True) class QualityAttributeMapping: """A data class used to map signal quality attributes to UDP Gen and TANGO attributes.""" udp_gen_arg: str """The argument use in UDP gen to simulate invalid packet.""" invalid_packets_attribute_name: str """The TANGO attribute name that reports the overall number of packets with invalid flag set.""" invalid_packet_rate_attribute_name: str """The TANGO attribute name that reports on instantaneous packet rate with invalid flag set.""" percentage_valid_attribute_name: str """The TANGO attribute name that reports on percentage of packets that are valid."""