CIM14/IEC61970/Core/PsrList.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.Core.IdentifiedObject import IdentifiedObject
  22
  23 class PsrList(IdentifiedObject):
  24     """Arbitrary list of PowerSystemResources. Can be used for various purposes, including grouping for report generation.
  25     """
  26
  27     def __init__(self, typePSRList='', PowerSystemResources=None, *args, **kw_args):
  28         """Initialises a new 'PsrList' instance.
  29
  30         @param typePSRList: Type of power system resources in this list.
  31         @param PowerSystemResources:
  32         """
  33         #: Type of power system resources in this list.
  34         self.typePSRList = typePSRList
  35
  36         self._PowerSystemResources = []
  37         self.PowerSystemResources = [] if PowerSystemResources is None else PowerSystemResources
  38
  39         super(PsrList, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["typePSRList"]
  42     _attr_types = {"typePSRList": str}
  43     _defaults = {"typePSRList": ''}
  44     _enums = {}
  45     _refs = ["PowerSystemResources"]
  46     _many_refs = ["PowerSystemResources"]
  47
  48     def getPowerSystemResources(self):
  49
  50         return self._PowerSystemResources
  51
  52     def setPowerSystemResources(self, value):
  53         for p in self._PowerSystemResources:
  54             filtered = [q for q in p.PsrLists if q != self]
  55             self._PowerSystemResources._PsrLists = filtered
  56         for r in value:
  57             if self not in r._PsrLists:
  58                 r._PsrLists.append(self)
  59         self._PowerSystemResources = value
  60
  61     PowerSystemResources = property(getPowerSystemResources, setPowerSystemResources)
  62
  63     def addPowerSystemResources(self, *PowerSystemResources):
  64         for obj in PowerSystemResources:
  65             if self not in obj._PsrLists:
  66                 obj._PsrLists.append(self)
  67             self._PowerSystemResources.append(obj)
  68
  69     def removePowerSystemResources(self, *PowerSystemResources):
  70         for obj in PowerSystemResources:
  71             if self in obj._PsrLists:
  72                 obj._PsrLists.remove(self)
  73             self._PowerSystemResources.remove(obj)
  74