Update README.rst
[PyCIM.git] / CIM14 / CPSM / StateVariables / Core / Terminal.py
blob0d5e346c551ccf31bdb97e16e4f6dd00ea50d57b
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.CPSM.StateVariables.Element import Element
23 class Terminal(Element):
24 """An electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called 'connectivity nodes'.
25 """
27 def __init__(self, SvPowerFlow=None, *args, **kw_args):
28 """Initialises a new 'Terminal' instance.
30 @param SvPowerFlow: The power flow state associated with the terminal.
31 """
32 self._SvPowerFlow = None
33 self.SvPowerFlow = SvPowerFlow
35 super(Terminal, self).__init__(*args, **kw_args)
37 _attrs = []
38 _attr_types = {}
39 _defaults = {}
40 _enums = {}
41 _refs = ["SvPowerFlow"]
42 _many_refs = []
44 def getSvPowerFlow(self):
45 """The power flow state associated with the terminal.
46 """
47 return self._SvPowerFlow
49 def setSvPowerFlow(self, value):
50 if self._SvPowerFlow is not None:
51 self._SvPowerFlow._Terminal = None
53 self._SvPowerFlow = value
54 if self._SvPowerFlow is not None:
55 self._SvPowerFlow.Terminal = None
56 self._SvPowerFlow._Terminal = self
58 SvPowerFlow = property(getSvPowerFlow, setSvPowerFlow)