Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / StateVariables / SvStatus.py
blobc20a8e9eb53f009b9076fd1b65a551b174c398ed
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.StateVariables.StateVariable import StateVariable
23 class SvStatus(StateVariable):
24 """State variable for status.
25 """
27 def __init__(self, inService=False, ConductingEquipment=None, *args, **kw_args):
28 """Initialises a new 'SvStatus' instance.
30 @param inService: The in service status as a result of topology processing.
31 @param ConductingEquipment: The conducting equipment associated with the status state.
32 """
33 #: The in service status as a result of topology processing.
34 self.inService = inService
36 self._ConductingEquipment = None
37 self.ConductingEquipment = ConductingEquipment
39 super(SvStatus, self).__init__(*args, **kw_args)
41 _attrs = ["inService"]
42 _attr_types = {"inService": bool}
43 _defaults = {"inService": False}
44 _enums = {}
45 _refs = ["ConductingEquipment"]
46 _many_refs = []
48 def getConductingEquipment(self):
49 """The conducting equipment associated with the status state.
50 """
51 return self._ConductingEquipment
53 def setConductingEquipment(self, value):
54 if self._ConductingEquipment is not None:
55 self._ConductingEquipment._SvStatus = None
57 self._ConductingEquipment = value
58 if self._ConductingEquipment is not None:
59 self._ConductingEquipment.SvStatus = None
60 self._ConductingEquipment._SvStatus = self
62 ConductingEquipment = property(getConductingEquipment, setConductingEquipment)