CIM14/IEC61970/Dynamics/UserBlockParameter.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.MetaBlockParameter import MetaBlockParameter
  22
  23 class UserBlockParameter(MetaBlockParameter):
  24     """Concrete class intended to obtain a parameter value from a user of the block  in the parameter list at the instance level.
  25     """
  26
  27     def __init__(self, BlockUsageParameter=None, *args, **kw_args):
  28         """Initialises a new 'UserBlockParameter' instance.
  29
  30         @param BlockUsageParameter:
  31         """
  32         self._BlockUsageParameter = []
  33         self.BlockUsageParameter = [] if BlockUsageParameter is None else BlockUsageParameter
  34
  35         super(UserBlockParameter, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["BlockUsageParameter"]
  42     _many_refs = ["BlockUsageParameter"]
  43
  44     def getBlockUsageParameter(self):
  45
  46         return self._BlockUsageParameter
  47
  48     def setBlockUsageParameter(self, value):
  49         for x in self._BlockUsageParameter:
  50             x.UserBlockParameter = None
  51         for y in value:
  52             y._UserBlockParameter = self
  53         self._BlockUsageParameter = value
  54
  55     BlockUsageParameter = property(getBlockUsageParameter, setBlockUsageParameter)
  56
  57     def addBlockUsageParameter(self, *BlockUsageParameter):
  58         for obj in BlockUsageParameter:
  59             obj.UserBlockParameter = self
  60
  61     def removeBlockUsageParameter(self, *BlockUsageParameter):
  62         for obj in BlockUsageParameter:
  63             obj.UserBlockParameter = None
  64