Update README.rst
[PyCIM.git] / CIM14 / CPSM / Equipment / Domain / __init__.py
blob866e8ba4732890811d13cbb044dcbe95fdd84cc5
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 """The domain package is a data dictionary of quantities and units that define datatypes for attributes (properties) that may be used by any class in any other package. This package contains the definition of primitive datatypes, including units of measure and permissible values. Each datatype contains a value attribute and an optional unit of measure, which is specified as a static variable initialized to the textual description of the unit of measure. The value of the 'units' string may be country or customer specific. Typical values are given. Permissible values for enumerations are listed in the documentation for the attribute using UML constraint syntax inside curly braces. Lengths of variable strings are listed in the descriptive text where required.
22 """
25 nsURI = "http://iec.ch/TC57/2009/CIM-schema-cim14?profile=http://iec.ch/TC57/2007/profile#Domain"
26 nsPrefix = "cimDomain"
29 class UnitSymbol(str):
30 """Values are: A, rad, none, g, W/Hz, V, m2, VA, VArh, N, Pa, VAh, F, H, Hz-1, W/s, J, m, S, min, deg, J/s, s, Wh, m3, oC, V/VAr, s-1, h, W, ohm, Hz, VAr, kg/J
31 """
32 pass
34 class Money(float):
35 """Amount of money
36 """
37 pass
39 class ApparentPower(float):
40 """Product of the RMS value of the voltage and the RMS value of the current
41 """
42 pass
44 class Resistance(float):
45 """Resistance (real part of impedance).
46 """
47 pass
49 class ActivePower(float):
50 """Product of RMS value of the voltage and the RMS value of the in-phase component of the current
51 """
52 pass
54 class Susceptance(float):
55 """Imaginary part of admittance.
56 """
57 pass
59 class CurrentFlow(float):
60 """Electrical current (positive flow is out of the ConductingEquipment into the ConnectivityNode)
61 """
62 pass
64 class Conductance(float):
65 """Factor by which voltage must be multiplied to give corresponding power lost from a circuit. Real part of admittance.
66 """
67 pass
69 class Length(float):
70 """Unit of length.
71 """
72 pass
74 class Reactance(float):
75 """Reactance (imaginary part of impedance), at rated frequency.
76 """
77 pass
79 class Seconds(float):
80 """Time, in seconds
81 """
82 pass
84 class VoltagePerReactivePower(float):
85 """Voltage variation with reactive power
86 """
87 pass
89 class Voltage(float):
90 """Electrical voltage.
91 """
92 pass
94 class ReactivePower(float):
95 """Product of RMS value of the voltage and the RMS value of the quadrature component of the current.
96 """
97 pass
99 class AngleDegrees(float):
100 """Measurement of angle in degrees
102 pass
104 class PerCent(float):
105 """Normally 0 - 100 on a defined base
107 pass