CIM14/IEC61970/Dynamics/MetaBlockConnectable.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 MetaBlockConnectable(IdentifiedObject):
  24     """This is a source connection for a block input at the dynamics meta-data level.   The subtypes represent different ways to obtain the numbers.  Note that a block output is NOT derived from this class since block outputs can only be computed from references to other blocks via the BlockOutputReference class.
  25     """
  26
  27     def __init__(self, StandardControlBlock_MetaBlockStateReference=None, MetaBlockOutputReference=None, MetaBlockStateReference=None, BlockInputReference=None, StandardControlBlock_MetaBlockInputReference=None, StandardControlBlock_MetaBlockParameterReference=None, MetaBlockParameterReference=None, StandardControlBlock_MetaBlockOutputReference=None, MetaBlockInputReference=None, *args, **kw_args):
  28         """Initialises a new 'MetaBlockConnectable' instance.
  29
  30         @param StandardControlBlock_MetaBlockStateReference:
  31         @param MetaBlockOutputReference:
  32         @param MetaBlockStateReference:
  33         @param BlockInputReference: Each block reference input is usually tied to one (sometimes zero for optional inputs) external block inputs or internal block reference outputs.
  34         @param StandardControlBlock_MetaBlockInputReference:
  35         @param StandardControlBlock_MetaBlockParameterReference:
  36         @param MetaBlockParameterReference:
  37         @param StandardControlBlock_MetaBlockOutputReference:
  38         @param MetaBlockInputReference:
  39         """
  40         self._StandardControlBlock_MetaBlockStateReference = []
  41         self.StandardControlBlock_MetaBlockStateReference = [] if StandardControlBlock_MetaBlockStateReference is None else StandardControlBlock_MetaBlockStateReference
  42
  43         self._MetaBlockOutputReference = []
  44         self.MetaBlockOutputReference = [] if MetaBlockOutputReference is None else MetaBlockOutputReference
  45
  46         self._MetaBlockStateReference = []
  47         self.MetaBlockStateReference = [] if MetaBlockStateReference is None else MetaBlockStateReference
  48
  49         self._BlockInputReference = []
  50         self.BlockInputReference = [] if BlockInputReference is None else BlockInputReference
  51
  52         self._StandardControlBlock_MetaBlockInputReference = []
  53         self.StandardControlBlock_MetaBlockInputReference = [] if StandardControlBlock_MetaBlockInputReference is None else StandardControlBlock_MetaBlockInputReference
  54
  55         self._StandardControlBlock_MetaBlockParameterReference = []
  56         self.StandardControlBlock_MetaBlockParameterReference = [] if StandardControlBlock_MetaBlockParameterReference is None else StandardControlBlock_MetaBlockParameterReference
  57
  58         self._MetaBlockParameterReference = []
  59         self.MetaBlockParameterReference = [] if MetaBlockParameterReference is None else MetaBlockParameterReference
  60
  61         self._StandardControlBlock_MetaBlockOutputReference = []
  62         self.StandardControlBlock_MetaBlockOutputReference = [] if StandardControlBlock_MetaBlockOutputReference is None else StandardControlBlock_MetaBlockOutputReference
  63
  64         self._MetaBlockInputReference = []
  65         self.MetaBlockInputReference = [] if MetaBlockInputReference is None else MetaBlockInputReference
  66
  67         super(MetaBlockConnectable, self).__init__(*args, **kw_args)
  68
  69     _attrs = []
  70     _attr_types = {}
  71     _defaults = {}
  72     _enums = {}
  73     _refs = ["StandardControlBlock_MetaBlockStateReference", "MetaBlockOutputReference", "MetaBlockStateReference", "BlockInputReference", "StandardControlBlock_MetaBlockInputReference", "StandardControlBlock_MetaBlockParameterReference", "MetaBlockParameterReference", "StandardControlBlock_MetaBlockOutputReference", "MetaBlockInputReference"]
  74     _many_refs = ["StandardControlBlock_MetaBlockStateReference", "MetaBlockOutputReference", "MetaBlockStateReference", "BlockInputReference", "StandardControlBlock_MetaBlockInputReference", "StandardControlBlock_MetaBlockParameterReference", "MetaBlockParameterReference", "StandardControlBlock_MetaBlockOutputReference", "MetaBlockInputReference"]
  75
  76     def getStandardControlBlock_MetaBlockStateReference(self):
  77
  78         return self._StandardControlBlock_MetaBlockStateReference
  79
  80     def setStandardControlBlock_MetaBlockStateReference(self, value):
  81         for x in self._StandardControlBlock_MetaBlockStateReference:
  82             x.StandardControlBlock_MetaBlockConnectable = None
  83         for y in value:
  84             y._StandardControlBlock_MetaBlockConnectable = self
  85         self._StandardControlBlock_MetaBlockStateReference = value
  86
  87     StandardControlBlock_MetaBlockStateReference = property(getStandardControlBlock_MetaBlockStateReference, setStandardControlBlock_MetaBlockStateReference)
  88
  89     def addStandardControlBlock_MetaBlockStateReference(self, *StandardControlBlock_MetaBlockStateReference):
  90         for obj in StandardControlBlock_MetaBlockStateReference:
  91             obj.StandardControlBlock_MetaBlockConnectable = self
  92
  93     def removeStandardControlBlock_MetaBlockStateReference(self, *StandardControlBlock_MetaBlockStateReference):
  94         for obj in StandardControlBlock_MetaBlockStateReference:
  95             obj.StandardControlBlock_MetaBlockConnectable = None
  96
  97     def getMetaBlockOutputReference(self):
  98
  99         return self._MetaBlockOutputReference
 100
 101     def setMetaBlockOutputReference(self, value):
 102         for x in self._MetaBlockOutputReference:
 103             x.MetaBlockConnectable = None
 104         for y in value:
 105             y._MetaBlockConnectable = self
 106         self._MetaBlockOutputReference = value
 107
 108     MetaBlockOutputReference = property(getMetaBlockOutputReference, setMetaBlockOutputReference)
 109
 110     def addMetaBlockOutputReference(self, *MetaBlockOutputReference):
 111         for obj in MetaBlockOutputReference:
 112             obj.MetaBlockConnectable = self
 113
 114     def removeMetaBlockOutputReference(self, *MetaBlockOutputReference):
 115         for obj in MetaBlockOutputReference:
 116             obj.MetaBlockConnectable = None
 117
 118     def getMetaBlockStateReference(self):
 119
 120         return self._MetaBlockStateReference
 121
 122     def setMetaBlockStateReference(self, value):
 123         for x in self._MetaBlockStateReference:
 124             x.MetaBlockConnectable = None
 125         for y in value:
 126             y._MetaBlockConnectable = self
 127         self._MetaBlockStateReference = value
 128
 129     MetaBlockStateReference = property(getMetaBlockStateReference, setMetaBlockStateReference)
 130
 131     def addMetaBlockStateReference(self, *MetaBlockStateReference):
 132         for obj in MetaBlockStateReference:
 133             obj.MetaBlockConnectable = self
 134
 135     def removeMetaBlockStateReference(self, *MetaBlockStateReference):
 136         for obj in MetaBlockStateReference:
 137             obj.MetaBlockConnectable = None
 138
 139     def getBlockInputReference(self):
 140         """Each block reference input is usually tied to one (sometimes zero for optional inputs) external block inputs or internal block reference outputs.
 141         """
 142         return self._BlockInputReference
 143
 144     def setBlockInputReference(self, value):
 145         for x in self._BlockInputReference:
 146             x.BlockConnectable = None
 147         for y in value:
 148             y._BlockConnectable = self
 149         self._BlockInputReference = value
 150
 151     BlockInputReference = property(getBlockInputReference, setBlockInputReference)
 152
 153     def addBlockInputReference(self, *BlockInputReference):
 154         for obj in BlockInputReference:
 155             obj.BlockConnectable = self
 156
 157     def removeBlockInputReference(self, *BlockInputReference):
 158         for obj in BlockInputReference:
 159             obj.BlockConnectable = None
 160
 161     def getStandardControlBlock_MetaBlockInputReference(self):
 162
 163         return self._StandardControlBlock_MetaBlockInputReference
 164
 165     def setStandardControlBlock_MetaBlockInputReference(self, value):
 166         for x in self._StandardControlBlock_MetaBlockInputReference:
 167             x.StandardControlBlock_MetaBlockConnectable = None
 168         for y in value:
 169             y._StandardControlBlock_MetaBlockConnectable = self
 170         self._StandardControlBlock_MetaBlockInputReference = value
 171
 172     StandardControlBlock_MetaBlockInputReference = property(getStandardControlBlock_MetaBlockInputReference, setStandardControlBlock_MetaBlockInputReference)
 173
 174     def addStandardControlBlock_MetaBlockInputReference(self, *StandardControlBlock_MetaBlockInputReference):
 175         for obj in StandardControlBlock_MetaBlockInputReference:
 176             obj.StandardControlBlock_MetaBlockConnectable = self
 177
 178     def removeStandardControlBlock_MetaBlockInputReference(self, *StandardControlBlock_MetaBlockInputReference):
 179         for obj in StandardControlBlock_MetaBlockInputReference:
 180             obj.StandardControlBlock_MetaBlockConnectable = None
 181
 182     def getStandardControlBlock_MetaBlockParameterReference(self):
 183
 184         return self._StandardControlBlock_MetaBlockParameterReference
 185
 186     def setStandardControlBlock_MetaBlockParameterReference(self, value):
 187         for x in self._StandardControlBlock_MetaBlockParameterReference:
 188             x.StandardControlBlock_MetaBlockConnectable = None
 189         for y in value:
 190             y._StandardControlBlock_MetaBlockConnectable = self
 191         self._StandardControlBlock_MetaBlockParameterReference = value
 192
 193     StandardControlBlock_MetaBlockParameterReference = property(getStandardControlBlock_MetaBlockParameterReference, setStandardControlBlock_MetaBlockParameterReference)
 194
 195     def addStandardControlBlock_MetaBlockParameterReference(self, *StandardControlBlock_MetaBlockParameterReference):
 196         for obj in StandardControlBlock_MetaBlockParameterReference:
 197             obj.StandardControlBlock_MetaBlockConnectable = self
 198
 199     def removeStandardControlBlock_MetaBlockParameterReference(self, *StandardControlBlock_MetaBlockParameterReference):
 200         for obj in StandardControlBlock_MetaBlockParameterReference:
 201             obj.StandardControlBlock_MetaBlockConnectable = None
 202
 203     def getMetaBlockParameterReference(self):
 204
 205         return self._MetaBlockParameterReference
 206
 207     def setMetaBlockParameterReference(self, value):
 208         for x in self._MetaBlockParameterReference:
 209             x.MetaBlockConnectable = None
 210         for y in value:
 211             y._MetaBlockConnectable = self
 212         self._MetaBlockParameterReference = value
 213
 214     MetaBlockParameterReference = property(getMetaBlockParameterReference, setMetaBlockParameterReference)
 215
 216     def addMetaBlockParameterReference(self, *MetaBlockParameterReference):
 217         for obj in MetaBlockParameterReference:
 218             obj.MetaBlockConnectable = self
 219
 220     def removeMetaBlockParameterReference(self, *MetaBlockParameterReference):
 221         for obj in MetaBlockParameterReference:
 222             obj.MetaBlockConnectable = None
 223
 224     def getStandardControlBlock_MetaBlockOutputReference(self):
 225
 226         return self._StandardControlBlock_MetaBlockOutputReference
 227
 228     def setStandardControlBlock_MetaBlockOutputReference(self, value):
 229         for x in self._StandardControlBlock_MetaBlockOutputReference:
 230             x.StandardControlBlock_MetaBlockConnectable = None
 231         for y in value:
 232             y._StandardControlBlock_MetaBlockConnectable = self
 233         self._StandardControlBlock_MetaBlockOutputReference = value
 234
 235     StandardControlBlock_MetaBlockOutputReference = property(getStandardControlBlock_MetaBlockOutputReference, setStandardControlBlock_MetaBlockOutputReference)
 236
 237     def addStandardControlBlock_MetaBlockOutputReference(self, *StandardControlBlock_MetaBlockOutputReference):
 238         for obj in StandardControlBlock_MetaBlockOutputReference:
 239             obj.StandardControlBlock_MetaBlockConnectable = self
 240
 241     def removeStandardControlBlock_MetaBlockOutputReference(self, *StandardControlBlock_MetaBlockOutputReference):
 242         for obj in StandardControlBlock_MetaBlockOutputReference:
 243             obj.StandardControlBlock_MetaBlockConnectable = None
 244
 245     def getMetaBlockInputReference(self):
 246
 247         return self._MetaBlockInputReference
 248
 249     def setMetaBlockInputReference(self, value):
 250         for x in self._MetaBlockInputReference:
 251             x.MetaBlockConnectable = None
 252         for y in value:
 253             y._MetaBlockConnectable = self
 254         self._MetaBlockInputReference = value
 255
 256     MetaBlockInputReference = property(getMetaBlockInputReference, setMetaBlockInputReference)
 257
 258     def addMetaBlockInputReference(self, *MetaBlockInputReference):
 259         for obj in MetaBlockInputReference:
 260             obj.MetaBlockConnectable = self
 261
 262     def removeMetaBlockInputReference(self, *MetaBlockInputReference):
 263         for obj in MetaBlockInputReference:
 264             obj.MetaBlockConnectable = None
 265