tdl-xoa-driver 1.0.0b1__py3-none-any.whl

xoa_driver/internals/commands/pec_commands.py

@@ -0,0 +1,265 @@
+from __future__ import annotations
+from dataclasses import dataclass
+import typing
+
+from xoa_driver.internals.core.builders import (
+    build_get_request,
+    build_set_request
+)
+from xoa_driver.internals.core import interfaces
+from xoa_driver.internals.core.token import Token
+from xoa_driver.internals.core.transporter.registry import register_command
+from xoa_driver.internals.core.transporter.protocol.payload import (
+    field,
+    RequestBodyStruct,
+    ResponseBodyStruct,
+    XmpByte,
+    XmpInt,
+    XmpLong,
+    XmpSequence,
+    XmpStr
+)
+from .enums import (
+    OnOff,
+    LatencyTypeCustomDist,
+)
+
+
+@register_command
+@dataclass
+class PEC_INDICES:
+    """
+    The full list of which custom distributions which are defined for a port. These
+    are the custom id values that are used for assigning the custom distributions to
+    an impairment. Setting the value of this command creates a new custom
+    distribution (default values) for each value that is not already in use, and
+    deletes each custom distribution that is not mentioned in the list. The same can
+    be accomplished one-custom-distribution-at-a-time using the PEC_VAL and
+    PEC_DELETE commands.
+
+    .. note::
+
+        Custom distributions which are currently defined are not affected when mentioned in a PEC_INDICES set command.
+        Custom distributions which are currently assigned to an impairment cannot be deleted and any attempt of deleting
+        such a custom distribution using either PEC_DELETE` or PEC_INDICES` will result in an error.
+
+    """
+
+    code: typing.ClassVar[int] = 1610
+    pushed: typing.ClassVar[bool] = True
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        indexations: typing.List[int] = field(XmpSequence(types_chunk=[XmpInt()]))
+        """list of integers, a list of the indices to the custom distributions which are currently defined on that port, max 40 elements."""
+
+    class SetDataAttr(RequestBodyStruct):
+        indexations: typing.List[int] = field(XmpSequence(types_chunk=[XmpInt()]))
+        """list of integers, a list of the indices to the custom distributions which are currently defined on that port, max 40 elements."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get a list of the indices to the custom distributions which are currently defined on that port.
+
+        :return: a list of the indices to the custom distributions which are currently defined on that port
+        :rtype: PEC_INDICES.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+
+    def set(self, indexations: typing.List[int]) -> Token[None]:
+        """Set a list of indices to create new custom distributions.
+
+        :param indexations: a list of indices to create new custom distributions
+        :type indexations: typing.List[int]
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indexations=indexations))
+
+
+@register_command
+@dataclass
+class PEC_VAL:
+    """
+    Definition of custom distribution. Custom distributions can be defined for
+    latency with 1024 entries and for non-latency impairments with 512 entries. Each
+    port will maintain a list of defined custom distributions, identified by an
+    CUST_ID. (Range: 1 - 40).
+    """
+
+    code: typing.ClassVar[int] = 1680
+    pushed: typing.ClassVar[bool] = True
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _custom_distribution_xindex: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        linear: OnOff = field(XmpByte())
+        """coded byte, defines the way the FPGA RAM content is played out."""
+        symmetric: OnOff = field(XmpByte())
+        """coded byte, reserved for future use, must be set to OFF."""
+        entry_count: int = field(XmpInt())
+        """integer, defines the number of entries in "dataX" (allowed value: 512,1024). NOTE: For Latency, 1024 entries are used, and for rest, 512 entries are used)"""
+        data_x: typing.List[int] = field(XmpSequence(types_chunk=[XmpLong()]))
+        """array of long integers, array size="num_entries", holds values to be filled in the RAM memory."""
+
+    class SetDataAttr(RequestBodyStruct):
+        linear: OnOff = field(XmpByte())
+        """coded byte, defines the way the FPGA RAM content is played out."""
+        symmetric: OnOff = field(XmpByte())
+        """coded byte, reserved for future use, must be set to OFF."""
+        entry_count: int = field(XmpInt())
+        """integer, defines the number of entries in "dataX" (allowed value: 512,1024). NOTE: For Latency, 1024 entries are used, and for rest, 512 entries are used)"""
+        data_x: typing.List[int] = field(XmpSequence(types_chunk=[XmpLong()]))
+        """array of long integers, array size="num_entries", holds values to be filled in the RAM memory."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the definition of custom distribution.
+
+        :return: definition of custom distribution
+        :rtype: PEC_VAL.GetDataAttr.
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._custom_distribution_xindex]))
+
+    def set(self, linear: OnOff, symmetric: OnOff, entry_count: int, data_x: typing.List[int]) -> Token[None]:
+        """Set the definition of custom distribution. Custom distributions can be defined for
+        latency with 1024 entries and for non-latency impairments with 512 entries. Each
+        port will maintain a list of defined custom distributions, identified by an
+        CUST_ID. (Range: 1 - 40).
+
+        :param linear: defines the way the FPGA RAM content is played out
+        :type linear: OnOff
+        :param symmetric: reserved for future use, must be set to 0.
+        :type symmetric: OnOff
+        :param entry_count: defines the number of entries in "data_x" (allowed value: 512,1024). For Latency, 1024 entries are used, and for rest, 512 entries are used.
+        :type entry_count: int
+        :param data_x: array size equals to "entry_count", holds values to be filled in the RAM memory.
+        :type data_x: typing.List[int]
+        """
+
+        return Token(
+            self._connection,
+            build_set_request(
+                self,
+                module=self._module,
+                port=self._port,
+                indices=[self._custom_distribution_xindex],
+                linear=linear,
+                symmetric=symmetric,
+                entry_count=entry_count,
+                data_x=data_x
+            )
+        )
+
+
+@register_command
+@dataclass
+class PEC_COMMENT:
+    """
+    Defines the user-defined description string of a custom distribution.
+    """
+
+    code: typing.ClassVar[int] = 1681
+    pushed: typing.ClassVar[bool] = True
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _custom_distribution_xindex: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        comment: str = field(XmpStr())
+        """string, the user-specified comment/description for the custom distribution."""
+
+    class SetDataAttr(RequestBodyStruct):
+        comment: str = field(XmpStr())
+        """string, the user-specified comment/description for the custom distribution."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the user-defined description string of a custom distribution.
+
+        :return: the user-specified comment/description for the custom distribution.
+        :rtype: PEC_COMMENT.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._custom_distribution_xindex]))
+
+    def set(self, comment: str) -> Token[None]:
+        """Set the user-defined description string of a custom distribution.
+
+        :param comment: the user-specified comment/description for the custom distribution.
+        :type comment: str
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._custom_distribution_xindex], comment=comment))
+
+
+@register_command
+@dataclass
+class PEC_DELETE:
+    """
+    Deletes the custom distribution definition.
+
+    .. note::
+
+        Once a customer has defined a customer distribution using PEC_VAL, it is defined until it is explicitly deleted.
+        Only customer distributions which are not referenced by any impairments, can be deleted.
+
+    """
+
+    code: typing.ClassVar[int] = 1682
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _custom_distribution_xindex: int
+
+    class SetDataAttr(RequestBodyStruct):
+        pass
+
+    def set(self) -> Token[None]:
+        """Deletes the custom distribution definition.
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._custom_distribution_xindex]))
+
+
+@register_command
+@dataclass
+class PEC_DISTTYPE:
+    """
+    Retrieves if a custom distribution is defined for latency or non-latency.
+
+    .. note::
+
+        Using PEC_DISTTYPE as set has no effect. The distribution type is determined upon custom distribution creation and cannot be modified later.
+        However, it is legal to issue the PEC_DISTTYPE set command with no effect.
+
+    """
+
+    code: typing.ClassVar[int] = 1683
+    pushed: typing.ClassVar[bool] = True
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _custom_distribution_xindex: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        latency_type: LatencyTypeCustomDist = field(XmpByte())
+        """byte, 0 indicates interpacket distribution, 1 indicates latency distribution."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the latency type of a custom distribution.
+
+        :return: latency type of a custom distribution
+        :rtype: PEC_DISTTYPE.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._custom_distribution_xindex]))