schemata/CIM14/IEC61970/Generation/Production/HydroPumpOpSchedule.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 HydroPumpOpSchedule(RegularIntervalSchedule):
  20     """The hydro pump's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses.The unit's operating schedule status is typically given as: (0=unavailable)  (1=avilable to startup or shutdown)  (2=must pump)
  21     """
  22
  23     def __init__(self, HydroPump=None, *args, **kw_args):
  24         """Initialises a new 'HydroPumpOpSchedule' instance.
  25
  26         @param HydroPump: The hydro pump has a pumping schedule over time, indicating when pumping is to occur.
  27         """
  28         self._HydroPump = None
  29         self.HydroPump = HydroPump
  30
  31         super(HydroPumpOpSchedule, self).__init__(*args, **kw_args)
  32
  33     _attrs = []
  34     _attr_types = {}
  35     _defaults = {}
  36     _enums = {}
  37     _refs = ["HydroPump"]
  38     _many_refs = []
  39
  40     def getHydroPump(self):
  41         """The hydro pump has a pumping schedule over time, indicating when pumping is to occur.
  42         """
  43         return self._HydroPump
  44
  45     def setHydroPump(self, value):
  46         if self._HydroPump is not None:
  47             self._HydroPump._HydroPumpOpSchedule = None
  48
  49         self._HydroPump = value
  50         if self._HydroPump is not None:
  51             self._HydroPump._HydroPumpOpSchedule = self
  52
  53     HydroPump = property(getHydroPump, setHydroPump)
  54