b972c4eb18558d7625a37844b470bd7652039a73
[csit.git] / resources / libraries / python / search / AbstractMeasurer.py
1 # Copyright (c) 2018 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(object):
20     """Abstract class defining common API for measurement providers."""
21
22     __metaclass__ = ABCMeta
23
24     @abstractmethod
25     def measure(self, duration, transmit_rate):
26         """Perform trial measurement and return the result.
27
28         :param duration: Trial duration [s].
29         :param transmit_rate: Target transmit rate [pps].
30         :type duration: float
31         :type transmit_rate: float
32         :returns: Structure containing the result of the measurement.
33         :rtype: ReceiveRateMeasurement
34         """
35         pass

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.