Adding CDPSM package.
[PyCIM.git] / CDPSM / Asset / IEC61968 / AssetModels / TapChangerInfo.py
blob757ce9bcec5065ca84fa66aadc20563f1ba4e30c
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 CDPSM.Asset.IEC61968.Assets.AssetInfo import AssetInfo
23 class TapChangerInfo(AssetInfo):
24 """Tap changer data.
25 """
27 def __init__(self, lowStep=0, frequency=0.0, ptRatio=0.0, ratedApparentPower=0.0, stepVoltageIncrement=0.0, ctRatio=0.0, ratedVoltage=0.0, neutralStep=0, ratedCurrent=0.0, ctRating=0.0, highStep=0, stepPhaseIncrement=0.0, neutralU=0.0, isTcul=False, *args, **kw_args):
28 """Initialises a new 'TapChangerInfo' instance.
30 @param lowStep: Lowest possible tap step position, retard from neutral.
31 @param frequency: Frequency at which the ratings apply.
32 @param ptRatio: Built-in voltage transducer ratio.
33 @param ratedApparentPower: Rated apparent power.
34 @param stepVoltageIncrement: Tap step increment, in per cent of rated voltage, per step position.
35 @param ctRatio: Built-in current transducer ratio.
36 @param ratedVoltage: Rated voltage.
37 @param neutralStep: The neutral tap step position for the winding.
38 @param ratedCurrent: Rated current.
39 @param ctRating: Built-in current transformer primary rating.
40 @param highStep: Highest possible tap step position, advance from neutral.
41 @param stepPhaseIncrement: Phase shift per step position.
42 @param neutralU: Voltage at which the winding operates at the neutral tap setting.
43 @param isTcul: Whether this tap changer has under load tap changing capabilities.
44 """
45 #: Lowest possible tap step position, retard from neutral.
46 self.lowStep = lowStep
48 #: Frequency at which the ratings apply.
49 self.frequency = frequency
51 #: Built-in voltage transducer ratio.
52 self.ptRatio = ptRatio
54 #: Rated apparent power.
55 self.ratedApparentPower = ratedApparentPower
57 #: Tap step increment, in per cent of rated voltage, per step position.
58 self.stepVoltageIncrement = stepVoltageIncrement
60 #: Built-in current transducer ratio.
61 self.ctRatio = ctRatio
63 #: Rated voltage.
64 self.ratedVoltage = ratedVoltage
66 #: The neutral tap step position for the winding.
67 self.neutralStep = neutralStep
69 #: Rated current.
70 self.ratedCurrent = ratedCurrent
72 #: Built-in current transformer primary rating.
73 self.ctRating = ctRating
75 #: Highest possible tap step position, advance from neutral.
76 self.highStep = highStep
78 #: Phase shift per step position.
79 self.stepPhaseIncrement = stepPhaseIncrement
81 #: Voltage at which the winding operates at the neutral tap setting.
82 self.neutralU = neutralU
84 #: Whether this tap changer has under load tap changing capabilities.
85 self.isTcul = isTcul
87 super(TapChangerInfo, self).__init__(*args, **kw_args)
89 _attrs = ["lowStep", "frequency", "ptRatio", "ratedApparentPower", "stepVoltageIncrement", "ctRatio", "ratedVoltage", "neutralStep", "ratedCurrent", "ctRating", "highStep", "stepPhaseIncrement", "neutralU", "isTcul"]
90 _attr_types = {"lowStep": int, "frequency": float, "ptRatio": float, "ratedApparentPower": float, "stepVoltageIncrement": float, "ctRatio": float, "ratedVoltage": float, "neutralStep": int, "ratedCurrent": float, "ctRating": float, "highStep": int, "stepPhaseIncrement": float, "neutralU": float, "isTcul": bool}
91 _defaults = {"lowStep": 0, "frequency": 0.0, "ptRatio": 0.0, "ratedApparentPower": 0.0, "stepVoltageIncrement": 0.0, "ctRatio": 0.0, "ratedVoltage": 0.0, "neutralStep": 0, "ratedCurrent": 0.0, "ctRating": 0.0, "highStep": 0, "stepPhaseIncrement": 0.0, "neutralU": 0.0, "isTcul": False}
92 _enums = {}
93 _refs = []
94 _many_refs = []