CIM15/IEC61970/Wires/FrequencyConverter.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 CIM15.IEC61970.Wires.RegulatingCondEq import RegulatingCondEq
  22
  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.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     """
  26
  27     def __init__(self, maxU=0.0, maxP=0.0, frequency=0.0, minP=0.0, minU=0.0, operatingMode='', *args, **kw_args):
  28         """Initialises a new 'FrequencyConverter' instance.
  29
  30         @param maxU: The maximum voltage on the DC side at which the frequency converter should operate.
  31         @param maxP: The maximum active power on the DC side at which the frequence converter should operate.
  32         @param frequency: Frequency on the AC side.
  33         @param minP: The minimum active power on the DC side at which the frequence converter should operate.
  34         @param minU: The minimum voltage on the DC side at which the frequency converter should operate.
  35         @param operatingMode: Operating mode for the frequency converter
  36         """
  37         #: The maximum voltage on the DC side at which the frequency converter should operate.
  38         self.maxU = maxU
  39
  40         #: The maximum active power on the DC side at which the frequence converter should operate.
  41         self.maxP = maxP
  42
  43         #: Frequency on the AC side.
  44         self.frequency = frequency
  45
  46         #: The minimum active power on the DC side at which the frequence converter should operate.
  47         self.minP = minP
  48
  49         #: The minimum voltage on the DC side at which the frequency converter should operate.
  50         self.minU = minU
  51
  52         #: Operating mode for the frequency converter
  53         self.operatingMode = operatingMode
  54
  55         super(FrequencyConverter, self).__init__(*args, **kw_args)
  56
  57     _attrs = ["maxU", "maxP", "frequency", "minP", "minU", "operatingMode"]
  58     _attr_types = {"maxU": float, "maxP": float, "frequency": float, "minP": float, "minU": float, "operatingMode": str}
  59     _defaults = {"maxU": 0.0, "maxP": 0.0, "frequency": 0.0, "minP": 0.0, "minU": 0.0, "operatingMode": ''}
  60     _enums = {}
  61     _refs = []
  62     _many_refs = []
  63