schemata/CIM14/IEC61970/Generation/Production/InflowForecast.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.IEC61970.Core.RegularIntervalSchedule import RegularIntervalSchedule
  18
  19 class InflowForecast(RegularIntervalSchedule):
  20     """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.
  21     """
  22
  23     def __init__(self, Reservoir=None, *args, **kw_args):
  24         """Initialises a new 'InflowForecast' instance.
  25
  26         @param Reservoir: A reservoir may have a 'natural' inflow forecast.
  27         """
  28         self._Reservoir = None
  29         self.Reservoir = Reservoir
  30
  31         super(InflowForecast, self).__init__(*args, **kw_args)
  32
  33     _attrs = []
  34     _attr_types = {}
  35     _defaults = {}
  36     _enums = {}
  37     _refs = ["Reservoir"]
  38     _many_refs = []
  39
  40     def getReservoir(self):
  41         """A reservoir may have a 'natural' inflow forecast.
  42         """
  43         return self._Reservoir
  44
  45     def setReservoir(self, value):
  46         if self._Reservoir is not None:
  47             filtered = [x for x in self.Reservoir.InflowForecasts if x != self]
  48             self._Reservoir._InflowForecasts = filtered
  49
  50         self._Reservoir = value
  51         if self._Reservoir is not None:
  52             self._Reservoir._InflowForecasts.append(self)
  53
  54     Reservoir = property(getReservoir, setReservoir)
  55