schemata/CIM14/IEC61970/Core/OperatingShare.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.Element import Element
  18
  19 class OperatingShare(Element):
  20     """Specifies the contract relationship between a PowerSystemResource and a contract participant.
  21     """
  22
  23     def __init__(self, percentage=0.0, PowerSystemResource=None, OperatingParticipant=None, *args, **kw_args):
  24         """Initialises a new 'OperatingShare' instance.
  25
  26         @param percentage: Percentage ownership for this device.   The percentage indicates the percentage ownership of the PSROwner for the PowerSystemResource.  The total percentage ownership for a PowerSystemResource should add to 100%.
  27         @param PowerSystemResource: The PowerSystemResource to which the attribues apply.   The percentage ownership of all owners of a PowerSystemResource should add to 100%.
  28         @param OperatingParticipant: The linkage to a owners  and its linkage attributes like percentage ownership.   The ownership percentage should add to 100% for all owners of a PowerSystemResource, but a PSROwner may own any percentage of any number of PowerSystemResource objects.
  29         """
  30         #: Percentage ownership for this device.   The percentage indicates the percentage ownership of the PSROwner for the PowerSystemResource.  The total percentage ownership for a PowerSystemResource should add to 100%.
  31         self.percentage = percentage
  32
  33         self._PowerSystemResource = None
  34         self.PowerSystemResource = PowerSystemResource
  35
  36         self._OperatingParticipant = None
  37         self.OperatingParticipant = OperatingParticipant
  38
  39         super(OperatingShare, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["percentage"]
  42     _attr_types = {"percentage": float}
  43     _defaults = {"percentage": 0.0}
  44     _enums = {}
  45     _refs = ["PowerSystemResource", "OperatingParticipant"]
  46     _many_refs = []
  47
  48     def getPowerSystemResource(self):
  49         """The PowerSystemResource to which the attribues apply.   The percentage ownership of all owners of a PowerSystemResource should add to 100%.
  50         """
  51         return self._PowerSystemResource
  52
  53     def setPowerSystemResource(self, value):
  54         if self._PowerSystemResource is not None:
  55             filtered = [x for x in self.PowerSystemResource.OperatingShare if x != self]
  56             self._PowerSystemResource._OperatingShare = filtered
  57
  58         self._PowerSystemResource = value
  59         if self._PowerSystemResource is not None:
  60             self._PowerSystemResource._OperatingShare.append(self)
  61
  62     PowerSystemResource = property(getPowerSystemResource, setPowerSystemResource)
  63
  64     def getOperatingParticipant(self):
  65         """The linkage to a owners  and its linkage attributes like percentage ownership.   The ownership percentage should add to 100% for all owners of a PowerSystemResource, but a PSROwner may own any percentage of any number of PowerSystemResource objects.
  66         """
  67         return self._OperatingParticipant
  68
  69     def setOperatingParticipant(self, value):
  70         if self._OperatingParticipant is not None:
  71             filtered = [x for x in self.OperatingParticipant.OperatingShare if x != self]
  72             self._OperatingParticipant._OperatingShare = filtered
  73
  74         self._OperatingParticipant = value
  75         if self._OperatingParticipant is not None:
  76             self._OperatingParticipant._OperatingShare.append(self)
  77
  78     OperatingParticipant = property(getOperatingParticipant, setOperatingParticipant)
  79