resources/libraries/python/MLRsearch/AbstractMeasurer.py

   1 # Copyright (c) 2020 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Module defining AbstractMeasurer class."""
  15
  16 from abc import ABCMeta, abstractmethod
  17
  18
  19 class AbstractMeasurer(metaclass=ABCMeta):
  20     """Abstract class defining common API for measurement providers."""
  21
  22     @abstractmethod
  23     def measure(self, duration, transmit_rate):
  24         """Perform trial measurement and return the result.
  25
  26         :param duration: Trial duration [s].
  27         :param transmit_rate: Target transmit rate [tps].
  28         :type duration: float
  29         :type transmit_rate: float
  30         :returns: Structure containing the result of the measurement.
  31         :rtype: ReceiveRateMeasurement.ReceiveRateMeasurement
  32         """