schemata/CIM14/IEC61970/LoadModel/EnergyArea.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.IEC61970.Core.IdentifiedObject import IdentifiedObject
  18
  19 class EnergyArea(IdentifiedObject):
  20     """The class describes an area having energy production or consumption. The class is the basis for further specialization.
  21     """
  22
  23     def __init__(self, ControlArea=None, *args, **kw_args):
  24         """Initialises a new 'EnergyArea' instance.
  25
  26         @param ControlArea: The control area specification that is used for the load forecast.
  27         """
  28         self._ControlArea = None
  29         self.ControlArea = ControlArea
  30
  31         super(EnergyArea, self).__init__(*args, **kw_args)
  32
  33     _attrs = []
  34     _attr_types = {}
  35     _defaults = {}
  36     _enums = {}
  37     _refs = ["ControlArea"]
  38     _many_refs = []
  39
  40     def getControlArea(self):
  41         """The control area specification that is used for the load forecast.
  42         """
  43         return self._ControlArea
  44
  45     def setControlArea(self, value):
  46         if self._ControlArea is not None:
  47             self._ControlArea._EnergyArea = None
  48
  49         self._ControlArea = value
  50         if self._ControlArea is not None:
  51             self._ControlArea._EnergyArea = self
  52
  53     ControlArea = property(getControlArea, setControlArea)
  54