CIM14/IEC61970/Generation/Production/InflowForecast.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.RegularIntervalSchedule import RegularIntervalSchedule
  22
  23 class InflowForecast(RegularIntervalSchedule):
  24     """Natural water inflow to a reservoir, usually forecasted from predicted rain and snowmelt. Typically in one hour increments for up to 10 days. The forecast is given in average cubic meters per second over the time increment.
  25     """
  26
  27     def __init__(self, Reservoir=None, *args, **kw_args):
  28         """Initialises a new 'InflowForecast' instance.
  29
  30         @param Reservoir: A reservoir may have a 'natural' inflow forecast.
  31         """
  32         self._Reservoir = None
  33         self.Reservoir = Reservoir
  34
  35         super(InflowForecast, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["Reservoir"]
  42     _many_refs = []
  43
  44     def getReservoir(self):
  45         """A reservoir may have a 'natural' inflow forecast.
  46         """
  47         return self._Reservoir
  48
  49     def setReservoir(self, value):
  50         if self._Reservoir is not None:
  51             filtered = [x for x in self.Reservoir.InflowForecasts if x != self]
  52             self._Reservoir._InflowForecasts = filtered
  53
  54         self._Reservoir = value
  55         if self._Reservoir is not None:
  56             if self not in self._Reservoir._InflowForecasts:
  57                 self._Reservoir._InflowForecasts.append(self)
  58
  59     Reservoir = property(getReservoir, setReservoir)
  60