CIM14/IEC61970/Dynamics/Motors/MotorSync.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 CIM14.IEC61970.Wires.SynchronousMachine import SynchronousMachine
  22
  23 class MotorSync(SynchronousMachine):
  24     """A large industrial motor or group of similar motors.  They are represented as <b>generators with negative Pgen</b> in the static (power flow) data.
  25     """
  26
  27     def __init__(self, synchronousMotorType="salientPole", *args, **kw_args):
  28         """Initialises a new 'MotorSync' instance.
  29
  30         @param synchronousMotorType: The type of synchronous motor, such as round rotor or salient pole. Values are: "salientPole", "roundRotor"
  31         """
  32         #: The type of synchronous motor, such as round rotor or salient pole. Values are: "salientPole", "roundRotor"
  33         self.synchronousMotorType = synchronousMotorType
  34
  35         super(MotorSync, self).__init__(*args, **kw_args)
  36
  37     _attrs = ["synchronousMotorType"]
  38     _attr_types = {"synchronousMotorType": str}
  39     _defaults = {"synchronousMotorType": "salientPole"}
  40     _enums = {"synchronousMotorType": "SynchronousMotorType"}
  41     _refs = []
  42     _many_refs = []
  43