CIM14/IEC61970/Wires/VoltageControlZone.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.PowerSystemResource import PowerSystemResource
  22
  23 class VoltageControlZone(PowerSystemResource):
  24     """An area of the power system network which is defined for secondary voltage control purposes. A voltage control zone consists of a collection of substations with a designated bus bar section whose voltage will be controlled.
  25     """
  26
  27     def __init__(self, RegulationSchedule=None, BusbarSection=None, *args, **kw_args):
  28         """Initialises a new 'VoltageControlZone' instance.
  29
  30         @param RegulationSchedule: A VoltageControlZone may have a  voltage regulation schedule.
  31         @param BusbarSection: A VoltageControlZone is controlled by a designated BusbarSection.
  32         """
  33         self._RegulationSchedule = None
  34         self.RegulationSchedule = RegulationSchedule
  35
  36         self._BusbarSection = None
  37         self.BusbarSection = BusbarSection
  38
  39         super(VoltageControlZone, self).__init__(*args, **kw_args)
  40
  41     _attrs = []
  42     _attr_types = {}
  43     _defaults = {}
  44     _enums = {}
  45     _refs = ["RegulationSchedule", "BusbarSection"]
  46     _many_refs = []
  47
  48     def getRegulationSchedule(self):
  49         """A VoltageControlZone may have a  voltage regulation schedule.
  50         """
  51         return self._RegulationSchedule
  52
  53     def setRegulationSchedule(self, value):
  54         if self._RegulationSchedule is not None:
  55             filtered = [x for x in self.RegulationSchedule.VoltageControlZones if x != self]
  56             self._RegulationSchedule._VoltageControlZones = filtered
  57
  58         self._RegulationSchedule = value
  59         if self._RegulationSchedule is not None:
  60             if self not in self._RegulationSchedule._VoltageControlZones:
  61                 self._RegulationSchedule._VoltageControlZones.append(self)
  62
  63     RegulationSchedule = property(getRegulationSchedule, setRegulationSchedule)
  64
  65     def getBusbarSection(self):
  66         """A VoltageControlZone is controlled by a designated BusbarSection.
  67         """
  68         return self._BusbarSection
  69
  70     def setBusbarSection(self, value):
  71         if self._BusbarSection is not None:
  72             self._BusbarSection._VoltageControlZone = None
  73
  74         self._BusbarSection = value
  75         if self._BusbarSection is not None:
  76             self._BusbarSection.VoltageControlZone = None
  77             self._BusbarSection._VoltageControlZone = self
  78
  79     BusbarSection = property(getBusbarSection, setBusbarSection)
  80