CIM14/IEC61970/Dynamics/BlockConstant.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.Dynamics.MetaBlockConnectable import MetaBlockConnectable
  22
  23 class BlockConstant(MetaBlockConnectable):
  24     """Used as a constant in the internal definition of a block.   This is meta dynamics model, so you need not specify this paramter in each usage of the block as a normal instance parameter.
  25     """
  26
  27     def __init__(self, value=0.0, metaBlock0=None, *args, **kw_args):
  28         """Initialises a new 'BlockConstant' instance.
  29
  30         @param value: The constant value of used for the internal defintion of a block.
  31         @param metaBlock0:
  32         """
  33         #: The constant value of used for the internal defintion of a block.
  34         self.value = value
  35
  36         self._metaBlock0 = None
  37         self.metaBlock0 = metaBlock0
  38
  39         super(BlockConstant, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["value"]
  42     _attr_types = {"value": float}
  43     _defaults = {"value": 0.0}
  44     _enums = {}
  45     _refs = ["metaBlock0"]
  46     _many_refs = []
  47
  48     def getmetaBlock0(self):
  49
  50         return self._metaBlock0
  51
  52     def setmetaBlock0(self, value):
  53         if self._metaBlock0 is not None:
  54             filtered = [x for x in self.metaBlock0.blockConstant0 if x != self]
  55             self._metaBlock0._blockConstant0 = filtered
  56
  57         self._metaBlock0 = value
  58         if self._metaBlock0 is not None:
  59             if self not in self._metaBlock0._blockConstant0:
  60                 self._metaBlock0._blockConstant0.append(self)
  61
  62     metaBlock0 = property(getmetaBlock0, setmetaBlock0)
  63