Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / Wires / FrequencyConverter.py
blob8b641ed4e3933eae2a7c59ca3485a22266cabcd2
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.Wires.RegulatingCondEq import RegulatingCondEq
23 class FrequencyConverter(RegulatingCondEq):
24 """A device to convert from one frequency to another (e.g., frequency F1 to F2) comprises a pair of FrequencyConverter instances. One converts from F1 to DC, the other converts the DC to F2.
25 """
27 def __init__(self, minU=0.0, maxU=0.0, maxP=0.0, minP=0.0, frequency=0.0, operatingMode='', *args, **kw_args):
28 """Initialises a new 'FrequencyConverter' instance.
30 @param minU: The minimum voltage on the DC side at which the frequency converter should operate.
31 @param maxU: The maximum voltage on the DC side at which the frequency converter should operate.
32 @param maxP: The maximum active power on the DC side at which the frequence converter should operate.
33 @param minP: The minimum active power on the DC side at which the frequence converter should operate.
34 @param frequency: Frequency on the AC side.
35 @param operatingMode: Operating mode for the frequency converter
36 """
37 #: The minimum voltage on the DC side at which the frequency converter should operate.
38 self.minU = minU
40 #: The maximum voltage on the DC side at which the frequency converter should operate.
41 self.maxU = maxU
43 #: The maximum active power on the DC side at which the frequence converter should operate.
44 self.maxP = maxP
46 #: The minimum active power on the DC side at which the frequence converter should operate.
47 self.minP = minP
49 #: Frequency on the AC side.
50 self.frequency = frequency
52 #: Operating mode for the frequency converter
53 self.operatingMode = operatingMode
55 super(FrequencyConverter, self).__init__(*args, **kw_args)
57 _attrs = ["minU", "maxU", "maxP", "minP", "frequency", "operatingMode"]
58 _attr_types = {"minU": float, "maxU": float, "maxP": float, "minP": float, "frequency": float, "operatingMode": str}
59 _defaults = {"minU": 0.0, "maxU": 0.0, "maxP": 0.0, "minP": 0.0, "frequency": 0.0, "operatingMode": ''}
60 _enums = {}
61 _refs = []
62 _many_refs = []