resources/tools/presentation/new/jumpavg/RunGroup.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 holding RunGroup class."""
  15
  16
  17 class RunGroup(object):
  18     """Effectively a named touple of data and metadata.
  19
  20     TODO: This feels like an abstract class.
  21     Most uses assume restrictions on metadata type.
  22     Can this be defined similarly to C++ templates?
  23     """
  24
  25     def __init__(self, metadata, values):
  26         """Create the group from metadata and values.
  27
  28         :param metadata: Metadata object to associate with the group.
  29         :param values: The runs belonging to this group.
  30         :type metadata: AbstractGroupMetadata
  31         :type values: Iterable of float or od AvgStdevMetadata
  32         """
  33         self.metadata = metadata
  34         self.values = values