CIM14/IEC61970/Generation/Production/TargetLevelSchedule.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.IEC61970.Core.Curve import Curve
  22
  23 class TargetLevelSchedule(Curve):
  24     """Reservoir water level targets from advanced studies or 'rule curves'. Typically in one hour increments for up to 10 days
  25     """
  26
  27     def __init__(self, highLevelLimit=0.0, lowLevelLimit=0.0, Reservoir=None, *args, **kw_args):
  28         """Initialises a new 'TargetLevelSchedule' instance.
  29
  30         @param highLevelLimit: High target level limit, above which the reservoir operation will be penalized
  31         @param lowLevelLimit: Low target level limit, below which the reservoir operation will be penalized
  32         @param Reservoir: A reservoir may have a water level target schedule.
  33         """
  34         #: High target level limit, above which the reservoir operation will be penalized
  35         self.highLevelLimit = highLevelLimit
  36
  37         #: Low target level limit, below which the reservoir operation will be penalized
  38         self.lowLevelLimit = lowLevelLimit
  39
  40         self._Reservoir = None
  41         self.Reservoir = Reservoir
  42
  43         super(TargetLevelSchedule, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["highLevelLimit", "lowLevelLimit"]
  46     _attr_types = {"highLevelLimit": float, "lowLevelLimit": float}
  47     _defaults = {"highLevelLimit": 0.0, "lowLevelLimit": 0.0}
  48     _enums = {}
  49     _refs = ["Reservoir"]
  50     _many_refs = []
  51
  52     def getReservoir(self):
  53         """A reservoir may have a water level target schedule.
  54         """
  55         return self._Reservoir
  56
  57     def setReservoir(self, value):
  58         if self._Reservoir is not None:
  59             self._Reservoir._TargetLevelSchedule = None
  60
  61         self._Reservoir = value
  62         if self._Reservoir is not None:
  63             self._Reservoir.TargetLevelSchedule = None
  64             self._Reservoir._TargetLevelSchedule = self
  65
  66     Reservoir = property(getReservoir, setReservoir)
  67