aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/search/AbstractMeasurer.py
diff options
context:
space:
mode:
Diffstat (limited to 'resources/libraries/python/search/AbstractMeasurer.py')
-rw-r--r--resources/libraries/python/search/AbstractMeasurer.py35
1 files changed, 35 insertions, 0 deletions
diff --git a/resources/libraries/python/search/AbstractMeasurer.py b/resources/libraries/python/search/AbstractMeasurer.py
new file mode 100644
index 0000000000..b972c4eb18
--- /dev/null
+++ b/resources/libraries/python/search/AbstractMeasurer.py
@@ -0,0 +1,35 @@
+# Copyright (c) 2018 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module defining AbstractMeasurer class."""
+
+from abc import ABCMeta, abstractmethod
+
+
+class AbstractMeasurer(object):
+ """Abstract class defining common API for measurement providers."""
+
+ __metaclass__ = ABCMeta
+
+ @abstractmethod
+ def measure(self, duration, transmit_rate):
+ """Perform trial measurement and return the result.
+
+ :param duration: Trial duration [s].
+ :param transmit_rate: Target transmit rate [pps].
+ :type duration: float
+ :type transmit_rate: float
+ :returns: Structure containing the result of the measurement.
+ :rtype: ReceiveRateMeasurement
+ """
+ pass