CIM14/IEC61970/StateVariables/SvVoltage.py

   1 # Copyright (C) 2010-2011 Richard Lincoln
   2 #
   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:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  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.
  20
  21 from CIM14.IEC61970.StateVariables.StateVariable import StateVariable
  22
  23 class SvVoltage(StateVariable):
  24     """State variable for voltage.
  25     """
  26
  27     def __init__(self, angle=0.0, v=0.0, TopologicalNode=None, *args, **kw_args):
  28         """Initialises a new 'SvVoltage' instance.
  29
  30         @param angle: The voltage angle in radians of the topological node.
  31         @param v: The voltage magnitude of the topological node.
  32         @param TopologicalNode: The topological node associated with the voltage state.
  33         """
  34         #: The voltage angle in radians of the topological node.
  35         self.angle = angle
  36
  37         #: The voltage magnitude of the topological node.
  38         self.v = v
  39
  40         self._TopologicalNode = None
  41         self.TopologicalNode = TopologicalNode
  42
  43         super(SvVoltage, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["angle", "v"]
  46     _attr_types = {"angle": float, "v": float}
  47     _defaults = {"angle": 0.0, "v": 0.0}
  48     _enums = {}
  49     _refs = ["TopologicalNode"]
  50     _many_refs = []
  51
  52     def getTopologicalNode(self):
  53         """The topological node associated with the voltage state.
  54         """
  55         return self._TopologicalNode
  56
  57     def setTopologicalNode(self, value):
  58         if self._TopologicalNode is not None:
  59             self._TopologicalNode._SvVoltage = None
  60
  61         self._TopologicalNode = value
  62         if self._TopologicalNode is not None:
  63             self._TopologicalNode.SvVoltage = None
  64             self._TopologicalNode._SvVoltage = self
  65
  66     TopologicalNode = property(getTopologicalNode, setTopologicalNode)
  67