Adding class meta-data attributes.
[PyCIM.git] / schemata / CIM14 / IEC61970 / Protection / SynchrocheckRelay.py
blob19257135ee4a2ac9139534b2ffbd67b2e8f0dada
1 # Copyright (C) 2010 Richard Lincoln
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.
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.
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
17 from CIM14.IEC61970.Protection.ProtectionEquipment import ProtectionEquipment
19 class SynchrocheckRelay(ProtectionEquipment):
20 """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.
21 """
23 def __init__(self, maxFreqDiff=0.0, maxVoltDiff=0.0, maxAngleDiff=0.0, *args, **kw_args):
24 """Initialises a new 'SynchrocheckRelay' instance.
26 @param maxFreqDiff: The maximum allowable frequency difference across the open device
27 @param maxVoltDiff: The maximum allowable difference voltage across the open device
28 @param maxAngleDiff: The maximum allowable voltage vector phase angle difference across the open device
29 """
30 #: The maximum allowable frequency difference across the open device
31 self.maxFreqDiff = maxFreqDiff
33 #: The maximum allowable difference voltage across the open device
34 self.maxVoltDiff = maxVoltDiff
36 #: The maximum allowable voltage vector phase angle difference across the open device
37 self.maxAngleDiff = maxAngleDiff
39 super(SynchrocheckRelay, self).__init__(*args, **kw_args)
41 _attrs = ["maxFreqDiff", "maxVoltDiff", "maxAngleDiff"]
42 _attr_types = {"maxFreqDiff": float, "maxVoltDiff": float, "maxAngleDiff": float}
43 _defaults = {"maxFreqDiff": 0.0, "maxVoltDiff": 0.0, "maxAngleDiff": 0.0}
44 _enums = {}
45 _refs = []
46 _many_refs = []