diff options
Diffstat (limited to 'resources/libraries/python/search/AbstractRateProvider.py')
-rw-r--r-- | resources/libraries/python/search/AbstractRateProvider.py | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/resources/libraries/python/search/AbstractRateProvider.py b/resources/libraries/python/search/AbstractRateProvider.py new file mode 100644 index 0000000000..125c2af8cc --- /dev/null +++ b/resources/libraries/python/search/AbstractRateProvider.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 AbstractRateProvider class.""" + +from abc import ABCMeta, abstractmethod + + +class AbstractRateProvider(object): + """Abstract class defining common API for rate 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 |