diff options
author | Vratko Polak <vrpolak@cisco.com> | 2018-07-10 14:07:02 +0200 |
---|---|---|
committer | Peter Mikus <pmikus@cisco.com> | 2018-07-12 04:23:17 +0000 |
commit | ad27739cd87a75b172fd415fc20db08983ea4e13 (patch) | |
tree | 42695d534cb19d3dc138ce4db8673244d3e3924b /resources/libraries/python/MLRsearch/AbstractMeasurer.py | |
parent | e3bed8e21e3c8b60734ce95eb2bb2a2d371a9907 (diff) |
CSIT-1186: Consume MLRsearch in agreed upon way
+ Rename search to MLRsearch in resources/libraries/python/.
+ Make PyPI/MLRsearch/MLRsearch a symlink to the renamed directory.
+ TrafficGenerator.py to import from the renamed directory/module.
- No change to MLRsearch code.
- Version stays at 0.1.1 to point to the latest released code.
Change-Id: I4a38b0b7f8f083fbb1a93b25522560144b4ef556
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'resources/libraries/python/MLRsearch/AbstractMeasurer.py')
-rw-r--r-- | resources/libraries/python/MLRsearch/AbstractMeasurer.py | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/resources/libraries/python/MLRsearch/AbstractMeasurer.py b/resources/libraries/python/MLRsearch/AbstractMeasurer.py new file mode 100644 index 0000000000..b972c4eb18 --- /dev/null +++ b/resources/libraries/python/MLRsearch/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 |