CIM14/Dynamics/Block.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.PowerSystemResource import PowerSystemResource
  18
  19 class Block(PowerSystemResource):
  20     """A specific usage of a dynamics block, supplied with parameters and any linkages to the power system static model that are required.     Sometimes a block is used to simply specify a location of input or output from dyanmics equations to the static model.
  21     """
  22
  23     def __init__(self, positiveFlowIn=False, inService=False, Terminal=None, MemberOf_BlockConnectivity=None, blockUsageInputReference0=None, BlockUsageOutputReference=None, PowerSystemResource=None, slotReference0=None, tieToMeasurement0=None, MetaBlock=None, BlockConnection=None, BlockParameter=None, *args, **kw_args):
  24         """Initialises a new 'Block' instance.
  25
  26         @param positiveFlowIn: If true then any flows associated with a terminal are referenced as positive into the device.
  27         @param inService:
  28         @param Terminal: The optional terminal to which the block applies.  This is used to link a specific terminal flow to the dynamics block.
  29         @param MemberOf_BlockConnectivity:
  30         @param blockUsageInputReference0:
  31         @param BlockUsageOutputReference:
  32         @param PowerSystemResource: The power system resource associated with the dyanmics block instance.   This is optional because sometimes no linkage is needed, yet parameters must be specified.  Also the linkage to Terminal can be used instead of the linkage to PowerSystemResource.
  33         @param slotReference0:
  34         @param tieToMeasurement0:
  35         @param MetaBlock:
  36         @param BlockConnection:
  37         @param BlockParameter:
  38         """
  39         #: If true then any flows associated with a terminal are referenced as positive into the device.
  40         self.positiveFlowIn = positiveFlowIn
  41
  42
  43         self.inService = inService
  44
  45         self._Terminal = None
  46         self.Terminal = Terminal
  47
  48         self._MemberOf_BlockConnectivity = None
  49         self.MemberOf_BlockConnectivity = MemberOf_BlockConnectivity
  50
  51         self._blockUsageInputReference0 = []
  52         self.blockUsageInputReference0 = [] if blockUsageInputReference0 is None else blockUsageInputReference0
  53
  54         self._BlockUsageOutputReference = []
  55         self.BlockUsageOutputReference = [] if BlockUsageOutputReference is None else BlockUsageOutputReference
  56
  57         self._PowerSystemResource = None
  58         self.PowerSystemResource = PowerSystemResource
  59
  60         self._slotReference0 = None
  61         self.slotReference0 = slotReference0
  62
  63         self._tieToMeasurement0 = []
  64         self.tieToMeasurement0 = [] if tieToMeasurement0 is None else tieToMeasurement0
  65
  66         self._MetaBlock = None
  67         self.MetaBlock = MetaBlock
  68
  69         self._BlockConnection = []
  70         self.BlockConnection = [] if BlockConnection is None else BlockConnection
  71
  72         self._BlockParameter = []
  73         self.BlockParameter = [] if BlockParameter is None else BlockParameter
  74
  75         super(Block, self).__init__(*args, **kw_args)
  76
  77     _attrs = ["positiveFlowIn", "inService"]
  78     _attr_types = {"positiveFlowIn": bool, "inService": bool}
  79     _defaults = {"positiveFlowIn": False, "inService": False}
  80     _enums = {}
  81     _refs = ["Terminal", "MemberOf_BlockConnectivity", "blockUsageInputReference0", "BlockUsageOutputReference", "PowerSystemResource", "slotReference0", "tieToMeasurement0", "MetaBlock", "BlockConnection", "BlockParameter"]
  82     _many_refs = ["blockUsageInputReference0", "BlockUsageOutputReference", "tieToMeasurement0", "BlockConnection", "BlockParameter"]
  83
  84     def getTerminal(self):
  85         """The optional terminal to which the block applies.  This is used to link a specific terminal flow to the dynamics block.
  86         """
  87         return self._Terminal
  88
  89     def setTerminal(self, value):
  90         if self._Terminal is not None:
  91             filtered = [x for x in self.Terminal.Block if x != self]
  92             self._Terminal._Block = filtered
  93
  94         self._Terminal = value
  95         if self._Terminal is not None:
  96             if self not in self._Terminal._Block:
  97                 self._Terminal._Block.append(self)
  98
  99     Terminal = property(getTerminal, setTerminal)
 100
 101     def getMemberOf_BlockConnectivity(self):
 102
 103         return self._MemberOf_BlockConnectivity
 104
 105     def setMemberOf_BlockConnectivity(self, value):
 106         if self._MemberOf_BlockConnectivity is not None:
 107             filtered = [x for x in self.MemberOf_BlockConnectivity.Block if x != self]
 108             self._MemberOf_BlockConnectivity._Block = filtered
 109
 110         self._MemberOf_BlockConnectivity = value
 111         if self._MemberOf_BlockConnectivity is not None:
 112             if self not in self._MemberOf_BlockConnectivity._Block:
 113                 self._MemberOf_BlockConnectivity._Block.append(self)
 114
 115     MemberOf_BlockConnectivity = property(getMemberOf_BlockConnectivity, setMemberOf_BlockConnectivity)
 116
 117     def getblockUsageInputReference0(self):
 118
 119         return self._blockUsageInputReference0
 120
 121     def setblockUsageInputReference0(self, value):
 122         for x in self._blockUsageInputReference0:
 123             x.block0 = None
 124         for y in value:
 125             y._block0 = self
 126         self._blockUsageInputReference0 = value
 127
 128     blockUsageInputReference0 = property(getblockUsageInputReference0, setblockUsageInputReference0)
 129
 130     def addblockUsageInputReference0(self, *blockUsageInputReference0):
 131         for obj in blockUsageInputReference0:
 132             obj.block0 = self
 133
 134     def removeblockUsageInputReference0(self, *blockUsageInputReference0):
 135         for obj in blockUsageInputReference0:
 136             obj.block0 = None
 137
 138     def getBlockUsageOutputReference(self):
 139
 140         return self._BlockUsageOutputReference
 141
 142     def setBlockUsageOutputReference(self, value):
 143         for x in self._BlockUsageOutputReference:
 144             x.block0 = None
 145         for y in value:
 146             y._block0 = self
 147         self._BlockUsageOutputReference = value
 148
 149     BlockUsageOutputReference = property(getBlockUsageOutputReference, setBlockUsageOutputReference)
 150
 151     def addBlockUsageOutputReference(self, *BlockUsageOutputReference):
 152         for obj in BlockUsageOutputReference:
 153             obj.block0 = self
 154
 155     def removeBlockUsageOutputReference(self, *BlockUsageOutputReference):
 156         for obj in BlockUsageOutputReference:
 157             obj.block0 = None
 158
 159     def getPowerSystemResource(self):
 160         """The power system resource associated with the dyanmics block instance.   This is optional because sometimes no linkage is needed, yet parameters must be specified.  Also the linkage to Terminal can be used instead of the linkage to PowerSystemResource.
 161         """
 162         return self._PowerSystemResource
 163
 164     def setPowerSystemResource(self, value):
 165         if self._PowerSystemResource is not None:
 166             filtered = [x for x in self.PowerSystemResource.Block if x != self]
 167             self._PowerSystemResource._Block = filtered
 168
 169         self._PowerSystemResource = value
 170         if self._PowerSystemResource is not None:
 171             if self not in self._PowerSystemResource._Block:
 172                 self._PowerSystemResource._Block.append(self)
 173
 174     PowerSystemResource = property(getPowerSystemResource, setPowerSystemResource)
 175
 176     def getslotReference0(self):
 177
 178         return self._slotReference0
 179
 180     def setslotReference0(self, value):
 181         if self._slotReference0 is not None:
 182             filtered = [x for x in self.slotReference0.block0 if x != self]
 183             self._slotReference0._block0 = filtered
 184
 185         self._slotReference0 = value
 186         if self._slotReference0 is not None:
 187             if self not in self._slotReference0._block0:
 188                 self._slotReference0._block0.append(self)
 189
 190     slotReference0 = property(getslotReference0, setslotReference0)
 191
 192     def gettieToMeasurement0(self):
 193
 194         return self._tieToMeasurement0
 195
 196     def settieToMeasurement0(self, value):
 197         for x in self._tieToMeasurement0:
 198             x.block0 = None
 199         for y in value:
 200             y._block0 = self
 201         self._tieToMeasurement0 = value
 202
 203     tieToMeasurement0 = property(gettieToMeasurement0, settieToMeasurement0)
 204
 205     def addtieToMeasurement0(self, *tieToMeasurement0):
 206         for obj in tieToMeasurement0:
 207             obj.block0 = self
 208
 209     def removetieToMeasurement0(self, *tieToMeasurement0):
 210         for obj in tieToMeasurement0:
 211             obj.block0 = None
 212
 213     def getMetaBlock(self):
 214
 215         return self._MetaBlock
 216
 217     def setMetaBlock(self, value):
 218         if self._MetaBlock is not None:
 219             filtered = [x for x in self.MetaBlock.Block if x != self]
 220             self._MetaBlock._Block = filtered
 221
 222         self._MetaBlock = value
 223         if self._MetaBlock is not None:
 224             if self not in self._MetaBlock._Block:
 225                 self._MetaBlock._Block.append(self)
 226
 227     MetaBlock = property(getMetaBlock, setMetaBlock)
 228
 229     def getBlockConnection(self):
 230
 231         return self._BlockConnection
 232
 233     def setBlockConnection(self, value):
 234         for x in self._BlockConnection:
 235             x.Block = None
 236         for y in value:
 237             y._Block = self
 238         self._BlockConnection = value
 239
 240     BlockConnection = property(getBlockConnection, setBlockConnection)
 241
 242     def addBlockConnection(self, *BlockConnection):
 243         for obj in BlockConnection:
 244             obj.Block = self
 245
 246     def removeBlockConnection(self, *BlockConnection):
 247         for obj in BlockConnection:
 248             obj.Block = None
 249
 250     def getBlockParameter(self):
 251
 252         return self._BlockParameter
 253
 254     def setBlockParameter(self, value):
 255         for x in self._BlockParameter:
 256             x.MemberOf_Block = None
 257         for y in value:
 258             y._MemberOf_Block = self
 259         self._BlockParameter = value
 260
 261     BlockParameter = property(getBlockParameter, setBlockParameter)
 262
 263     def addBlockParameter(self, *BlockParameter):
 264         for obj in BlockParameter:
 265             obj.MemberOf_Block = self
 266
 267     def removeBlockParameter(self, *BlockParameter):
 268         for obj in BlockParameter:
 269             obj.MemberOf_Block = None
 270