CIM14/CPSM/Equipment/Wires/Switch.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.CPSM.Equipment.Core.ConductingEquipment import ConductingEquipment
  22
  23 class Switch(ConductingEquipment):
  24     """A generic device designed to close, or open, or both, one or more electric circuits.-  [R6.2] and [R6.3] are satisfied by navigation to ConnectivityNode and Substation -  [R6.4] is satisfied by the class name.
  25     """
  26
  27     def __init__(self, normalOpen=False, SwitchSchedules=None, *args, **kw_args):
  28         """Initialises a new 'Switch' instance.
  29
  30         @param normalOpen: The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurment the Discrete.normalValue is expected to match with the Switch.normalOpen.
  31         @param SwitchSchedules: A Switch can be associated with SwitchSchedules.
  32         """
  33         #: The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurment the Discrete.normalValue is expected to match with the Switch.normalOpen.
  34         self.normalOpen = normalOpen
  35
  36         self._SwitchSchedules = []
  37         self.SwitchSchedules = [] if SwitchSchedules is None else SwitchSchedules
  38
  39         super(Switch, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["normalOpen"]
  42     _attr_types = {"normalOpen": bool}
  43     _defaults = {"normalOpen": False}
  44     _enums = {}
  45     _refs = ["SwitchSchedules"]
  46     _many_refs = ["SwitchSchedules"]
  47
  48     def getSwitchSchedules(self):
  49         """A Switch can be associated with SwitchSchedules.
  50         """
  51         return self._SwitchSchedules
  52
  53     def setSwitchSchedules(self, value):
  54         for x in self._SwitchSchedules:
  55             x.Switch = None
  56         for y in value:
  57             y._Switch = self
  58         self._SwitchSchedules = value
  59
  60     SwitchSchedules = property(getSwitchSchedules, setSwitchSchedules)
  61
  62     def addSwitchSchedules(self, *SwitchSchedules):
  63         for obj in SwitchSchedules:
  64             obj.Switch = self
  65
  66     def removeSwitchSchedules(self, *SwitchSchedules):
  67         for obj in SwitchSchedules:
  68             obj.Switch = None
  69