CIM14/IEC61970/Protection/CurrentRelay.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.Protection.ProtectionEquipment import ProtectionEquipment
  18
  19 class CurrentRelay(ProtectionEquipment):
  20     """A device that checks current flow values in any direction or designated direction
  21     """
  22
  23     def __init__(self, currentLimit1=0.0, timeDelay3=0.0, timeDelay2=0.0, currentLimit3=0.0, currentLimit2=0.0, inverseTimeFlag=False, timeDelay1=0.0, *args, **kw_args):
  24         """Initialises a new 'CurrentRelay' instance.
  25
  26         @param currentLimit1: Current limit #1 for inverse time pickup
  27         @param timeDelay3: Inverse time delay #3 for current limit #3
  28         @param timeDelay2: Inverse time delay #2 for current limit #2
  29         @param currentLimit3: Current limit #3 for inverse time pickup
  30         @param currentLimit2: Current limit #2 for inverse time pickup
  31         @param inverseTimeFlag: Set true if the current relay has inverse time characteristic.
  32         @param timeDelay1: Inverse time delay #1 for current limit #1
  33         """
  34         #: Current limit #1 for inverse time pickup
  35         self.currentLimit1 = currentLimit1
  36
  37         #: Inverse time delay #3 for current limit #3
  38         self.timeDelay3 = timeDelay3
  39
  40         #: Inverse time delay #2 for current limit #2
  41         self.timeDelay2 = timeDelay2
  42
  43         #: Current limit #3 for inverse time pickup
  44         self.currentLimit3 = currentLimit3
  45
  46         #: Current limit #2 for inverse time pickup
  47         self.currentLimit2 = currentLimit2
  48
  49         #: Set true if the current relay has inverse time characteristic.
  50         self.inverseTimeFlag = inverseTimeFlag
  51
  52         #: Inverse time delay #1 for current limit #1
  53         self.timeDelay1 = timeDelay1
  54
  55         super(CurrentRelay, self).__init__(*args, **kw_args)
  56
  57     _attrs = ["currentLimit1", "timeDelay3", "timeDelay2", "currentLimit3", "currentLimit2", "inverseTimeFlag", "timeDelay1"]
  58     _attr_types = {"currentLimit1": float, "timeDelay3": float, "timeDelay2": float, "currentLimit3": float, "currentLimit2": float, "inverseTimeFlag": bool, "timeDelay1": float}
  59     _defaults = {"currentLimit1": 0.0, "timeDelay3": 0.0, "timeDelay2": 0.0, "currentLimit3": 0.0, "currentLimit2": 0.0, "inverseTimeFlag": False, "timeDelay1": 0.0}
  60     _enums = {}
  61     _refs = []
  62     _many_refs = []
  63