CIM14/IEC61970/Protection/SynchrocheckRelay.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.Protection.ProtectionEquipment import ProtectionEquipment
  22
  23 class SynchrocheckRelay(ProtectionEquipment):
  24     """A device that operates when two AC circuits are within the desired limits of frequency, phase angle, and voltage, to permit or to cause the paralleling of these two circuits. Used to prevent the paralleling of non-synchronous topological islands.
  25     """
  26
  27     def __init__(self, maxFreqDiff=0.0, maxVoltDiff=0.0, maxAngleDiff=0.0, *args, **kw_args):
  28         """Initialises a new 'SynchrocheckRelay' instance.
  29
  30         @param maxFreqDiff: The maximum allowable frequency difference across the open device
  31         @param maxVoltDiff: The maximum allowable difference voltage across the open device
  32         @param maxAngleDiff: The maximum allowable voltage vector phase angle difference across the open device
  33         """
  34         #: The maximum allowable frequency difference across the open device
  35         self.maxFreqDiff = maxFreqDiff
  36
  37         #: The maximum allowable difference voltage across the open device
  38         self.maxVoltDiff = maxVoltDiff
  39
  40         #: The maximum allowable voltage vector phase angle difference across the open device
  41         self.maxAngleDiff = maxAngleDiff
  42
  43         super(SynchrocheckRelay, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["maxFreqDiff", "maxVoltDiff", "maxAngleDiff"]
  46     _attr_types = {"maxFreqDiff": float, "maxVoltDiff": float, "maxAngleDiff": float}
  47     _defaults = {"maxFreqDiff": 0.0, "maxVoltDiff": 0.0, "maxAngleDiff": 0.0}
  48     _enums = {}
  49     _refs = []
  50     _many_refs = []
  51