CIM14/IEC61970/Protection/RecloseSequence.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.IdentifiedObject import IdentifiedObject
  22
  23 class RecloseSequence(IdentifiedObject):
  24     """A reclose sequence (open and close) is defined for each possible reclosure of a breaker.
  25     """
  26
  27     def __init__(self, recloseDelay=0.0, recloseStep=0, ProtectedSwitch=None, *args, **kw_args):
  28         """Initialises a new 'RecloseSequence' instance.
  29
  30         @param recloseDelay: Indicates the time lapse before the reclose step will execute a reclose.
  31         @param recloseStep: Indicates the ordinal position of the reclose step relative to other steps in the sequence.
  32         @param ProtectedSwitch: A breaker may have zero or more automatic reclosures after a trip occurs.
  33         """
  34         #: Indicates the time lapse before the reclose step will execute a reclose.
  35         self.recloseDelay = recloseDelay
  36
  37         #: Indicates the ordinal position of the reclose step relative to other steps in the sequence.
  38         self.recloseStep = recloseStep
  39
  40         self._ProtectedSwitch = None
  41         self.ProtectedSwitch = ProtectedSwitch
  42
  43         super(RecloseSequence, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["recloseDelay", "recloseStep"]
  46     _attr_types = {"recloseDelay": float, "recloseStep": int}
  47     _defaults = {"recloseDelay": 0.0, "recloseStep": 0}
  48     _enums = {}
  49     _refs = ["ProtectedSwitch"]
  50     _many_refs = []
  51
  52     def getProtectedSwitch(self):
  53         """A breaker may have zero or more automatic reclosures after a trip occurs.
  54         """
  55         return self._ProtectedSwitch
  56
  57     def setProtectedSwitch(self, value):
  58         if self._ProtectedSwitch is not None:
  59             filtered = [x for x in self.ProtectedSwitch.RecloseSequences if x != self]
  60             self._ProtectedSwitch._RecloseSequences = filtered
  61
  62         self._ProtectedSwitch = value
  63         if self._ProtectedSwitch is not None:
  64             if self not in self._ProtectedSwitch._RecloseSequences:
  65                 self._ProtectedSwitch._RecloseSequences.append(self)
  66
  67     ProtectedSwitch = property(getProtectedSwitch, setProtectedSwitch)
  68