Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / Wires / RectifierInverter.py
bloba339cf27c0711c6afedf2dbda0ff5de48c061f1a
1 # Copyright (C) 2010-2011 Richard Lincoln
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:
10 # The above copyright notice and this permission notice shall be included in
11 # all copies or substantial portions of the Software.
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.
21 from CIM14.IEC61970.Core.ConductingEquipment import ConductingEquipment
23 class RectifierInverter(ConductingEquipment):
24 """Bi-directional AC-DC conversion equipment that can be used to control DC current, DC voltage, DC power flow, or firing angle.
25 """
27 def __init__(self, ratedU=0.0, compoundResistance=0.0, frequency=0.0, minCompoundVoltage=0.0, minP=0.0, maxP=0.0, operatingMode='', commutatingResistance=0.0, bridges=0, maxU=0.0, commutatingReactance=0.0, minU=0.0, *args, **kw_args):
28 """Initialises a new 'RectifierInverter' instance.
30 @param ratedU: Rectifier/inverter primary base voltage
31 @param compoundResistance: Compounding resistance.
32 @param frequency: Frequency on the AC side.
33 @param minCompoundVoltage: Minimum compounded DC voltage
34 @param minP: The minimum active power on the DC side at which the converter should operate.
35 @param maxP: The maximum active power on the DC side at which the fconverter should operate.
36 @param operatingMode: Operating mode for the converter.
37 @param commutatingResistance: Commutating resistance.
38 @param bridges: Number of bridges
39 @param maxU: The maximum voltage on the DC side at which the converter should operate.
40 @param commutatingReactance: Commutating reactance at AC bus frequency.
41 @param minU: The minimum voltage on the DC side at which the converter should operate.
42 """
43 #: Rectifier/inverter primary base voltage
44 self.ratedU = ratedU
46 #: Compounding resistance.
47 self.compoundResistance = compoundResistance
49 #: Frequency on the AC side.
50 self.frequency = frequency
52 #: Minimum compounded DC voltage
53 self.minCompoundVoltage = minCompoundVoltage
55 #: The minimum active power on the DC side at which the converter should operate.
56 self.minP = minP
58 #: The maximum active power on the DC side at which the fconverter should operate.
59 self.maxP = maxP
61 #: Operating mode for the converter.
62 self.operatingMode = operatingMode
64 #: Commutating resistance.
65 self.commutatingResistance = commutatingResistance
67 #: Number of bridges
68 self.bridges = bridges
70 #: The maximum voltage on the DC side at which the converter should operate.
71 self.maxU = maxU
73 #: Commutating reactance at AC bus frequency.
74 self.commutatingReactance = commutatingReactance
76 #: The minimum voltage on the DC side at which the converter should operate.
77 self.minU = minU
79 super(RectifierInverter, self).__init__(*args, **kw_args)
81 _attrs = ["ratedU", "compoundResistance", "frequency", "minCompoundVoltage", "minP", "maxP", "operatingMode", "commutatingResistance", "bridges", "maxU", "commutatingReactance", "minU"]
82 _attr_types = {"ratedU": float, "compoundResistance": float, "frequency": float, "minCompoundVoltage": float, "minP": float, "maxP": float, "operatingMode": str, "commutatingResistance": float, "bridges": int, "maxU": float, "commutatingReactance": float, "minU": float}
83 _defaults = {"ratedU": 0.0, "compoundResistance": 0.0, "frequency": 0.0, "minCompoundVoltage": 0.0, "minP": 0.0, "maxP": 0.0, "operatingMode": '', "commutatingResistance": 0.0, "bridges": 0, "maxU": 0.0, "commutatingReactance": 0.0, "minU": 0.0}
84 _enums = {}
85 _refs = []
86 _many_refs = []