Fixing website and API documentation links
[PyCIM.git] / CIM15 / IEC61968 / AssetModels / EndDeviceInfo.py
blob261e83c9d990c779af4311448acfd0857d65ae08
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 CIM15.IEC61968.Assets.AssetInfo import AssetInfo
23 class EndDeviceInfo(AssetInfo):
24 """End device data.End device data.
25 """
27 def __init__(self, phaseCount=0, ratedCurrent=0.0, ratedVoltage=0.0, EndDevices=None, *args, **kw_args):
28 """Initialises a new 'EndDeviceInfo' instance.
30 @param phaseCount: Number of potential phases the end device supports, typically 0, 1 or 3.
31 @param ratedCurrent: Rated current.
32 @param ratedVoltage: Rated voltage.
33 @param EndDevices: All end devices described with this data.
34 """
35 #: Number of potential phases the end device supports, typically 0, 1 or 3.
36 self.phaseCount = phaseCount
38 #: Rated current.
39 self.ratedCurrent = ratedCurrent
41 #: Rated voltage.
42 self.ratedVoltage = ratedVoltage
44 self._EndDevices = []
45 self.EndDevices = [] if EndDevices is None else EndDevices
47 super(EndDeviceInfo, self).__init__(*args, **kw_args)
49 _attrs = ["phaseCount", "ratedCurrent", "ratedVoltage"]
50 _attr_types = {"phaseCount": int, "ratedCurrent": float, "ratedVoltage": float}
51 _defaults = {"phaseCount": 0, "ratedCurrent": 0.0, "ratedVoltage": 0.0}
52 _enums = {}
53 _refs = ["EndDevices"]
54 _many_refs = ["EndDevices"]
56 def getEndDevices(self):
57 """All end devices described with this data.
58 """
59 return self._EndDevices
61 def setEndDevices(self, value):
62 for x in self._EndDevices:
63 x.EndDeviceInfo = None
64 for y in value:
65 y._EndDeviceInfo = self
66 self._EndDevices = value
68 EndDevices = property(getEndDevices, setEndDevices)
70 def addEndDevices(self, *EndDevices):
71 for obj in EndDevices:
72 obj.EndDeviceInfo = self
74 def removeEndDevices(self, *EndDevices):
75 for obj in EndDevices:
76 obj.EndDeviceInfo = None