CIM14/ENTSOE/Equipment/Core/RegularIntervalSchedule.py

   1 # Copyright (C) 2010-2011 Richard Lincoln
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining a copy
   4 # of this software and associated documentation files (the "Software"), to
   5 # deal in the Software without restriction, including without limitation the
   6 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 # sell copies of the Software, and to permit persons to whom the Software is
   8 # furnished to do so, subject to the following conditions:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19 # IN THE SOFTWARE.
  20
  21 from CIM14.ENTSOE.Equipment.Core.BasicIntervalSchedule import BasicIntervalSchedule
  22
  23 class RegularIntervalSchedule(BasicIntervalSchedule):
  24     """The schedule has TimePoints where the time between them is constant.
  25     """
  26
  27     def __init__(self, timeStep=0.0, endTime='', *args, **kw_args):
  28         """Initialises a new 'RegularIntervalSchedule' instance.
  29
  30         @param timeStep: The time between each pair of subsequent RegularTimePoints.
  31         @param endTime: The time for the last time point.
  32         """
  33         #: The time between each pair of subsequent RegularTimePoints.
  34         self.timeStep = timeStep
  35
  36         #: The time for the last time point.
  37         self.endTime = endTime
  38
  39         super(RegularIntervalSchedule, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["timeStep", "endTime"]
  42     _attr_types = {"timeStep": float, "endTime": str}
  43     _defaults = {"timeStep": 0.0, "endTime": ''}
  44     _enums = {}
  45     _refs = []
  46     _many_refs = []
  47