Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / Meas / CurrentTransformer.py
blobf52bacd66d0a5117aa3f5f84893933c1ada31bee
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.Core.Equipment import Equipment
23 class CurrentTransformer(Equipment):
24 """Instrument transformer used to measure electrical qualities of the circuit that is being protected and/or monitored. Typically used as current transducer for the purpose of metering or protection. A typical secondary current rating would be 5A.
25 """
27 def __init__(self, maxRatio=0.0, accuracyClass='', coreCount=0, ctClass='', usage='', accuracyLimit='', *args, **kw_args):
28 """Initialises a new 'CurrentTransformer' instance.
30 @param maxRatio: For multi-ratio CT's, the maximum permissable ratio attainable.
31 @param accuracyClass: CT accuracy classification.
32 @param coreCount: Number of cores.
33 @param ctClass: CT classification; i.e. class 10P.
34 @param usage: Intended usage of the CT; i.e. metering, protection.
35 @param accuracyLimit: Percent of rated current for which the CT remains accurate within specified limits.
36 """
37 #: For multi-ratio CT's, the maximum permissable ratio attainable.
38 self.maxRatio = maxRatio
40 #: CT accuracy classification.
41 self.accuracyClass = accuracyClass
43 #: Number of cores.
44 self.coreCount = coreCount
46 #: CT classification; i.e. class 10P.
47 self.ctClass = ctClass
49 #: Intended usage of the CT; i.e. metering, protection.
50 self.usage = usage
52 #: Percent of rated current for which the CT remains accurate within specified limits.
53 self.accuracyLimit = accuracyLimit
55 super(CurrentTransformer, self).__init__(*args, **kw_args)
57 _attrs = ["maxRatio", "accuracyClass", "coreCount", "ctClass", "usage", "accuracyLimit"]
58 _attr_types = {"maxRatio": float, "accuracyClass": str, "coreCount": int, "ctClass": str, "usage": str, "accuracyLimit": str}
59 _defaults = {"maxRatio": 0.0, "accuracyClass": '', "coreCount": 0, "ctClass": '', "usage": '', "accuracyLimit": ''}
60 _enums = {}
61 _refs = []
62 _many_refs = []