CIM15/IEC61970/Informative/InfWork/WorkCostDetail.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 CIM15.IEC61968.Common.Document import Document
  22
  23 class WorkCostDetail(Document):
  24     """A collection of all of the individual cost items collected from multiple sources.A collection of all of the individual cost items collected from multiple sources.
  25     """
  26
  27     def __init__(self, type='', isDebit=False, transactionDateTime='', amount=0.0, WorkTask=None, Works=None, Design=None, MiscCostItems=None, WorkCostSummary=None, PropertyUnits=None, ErpProjectAccounting=None, LaborItems=None, MaterialItems=None, EquipmentItems=None, ContractorItems=None, OverheadCost=None, CostType=None, *args, **kw_args):
  28         """Initialises a new 'WorkCostDetail' instance.
  29
  30         @param type: Type of work cost.
  31         @param isDebit: True if 'amount' is a debit, false if it is a credit.
  32         @param transactionDateTime: Date and time that 'amount' is posted to the work.
  33         @param amount: Amount in designated currency for work, either a total or an individual element. As defined in the attribute 'type,' multiple instances are applicable to each work for: planned cost, actual cost, authorized cost, budgeted cost, forecasted cost, other.
  34         @param WorkTask:
  35         @param Works:
  36         @param Design:
  37         @param MiscCostItems:
  38         @param WorkCostSummary:
  39         @param PropertyUnits:
  40         @param ErpProjectAccounting:
  41         @param LaborItems:
  42         @param MaterialItems:
  43         @param EquipmentItems:
  44         @param ContractorItems:
  45         @param OverheadCost:
  46         @param CostType:
  47         """
  48         #: Type of work cost.
  49         self.type = type
  50
  51         #: True if 'amount' is a debit, false if it is a credit.
  52         self.isDebit = isDebit
  53
  54         #: Date and time that 'amount' is posted to the work.
  55         self.transactionDateTime = transactionDateTime
  56
  57         #: Amount in designated currency for work, either a total or an individual element. As defined in the attribute 'type,' multiple instances are applicable to each work for: planned cost, actual cost, authorized cost, budgeted cost, forecasted cost, other.
  58         self.amount = amount
  59
  60         self._WorkTask = None
  61         self.WorkTask = WorkTask
  62
  63         self._Works = []
  64         self.Works = [] if Works is None else Works
  65
  66         self._Design = None
  67         self.Design = Design
  68
  69         self._MiscCostItems = []
  70         self.MiscCostItems = [] if MiscCostItems is None else MiscCostItems
  71
  72         self._WorkCostSummary = None
  73         self.WorkCostSummary = WorkCostSummary
  74
  75         self._PropertyUnits = []
  76         self.PropertyUnits = [] if PropertyUnits is None else PropertyUnits
  77
  78         self._ErpProjectAccounting = None
  79         self.ErpProjectAccounting = ErpProjectAccounting
  80
  81         self._LaborItems = []
  82         self.LaborItems = [] if LaborItems is None else LaborItems
  83
  84         self._MaterialItems = []
  85         self.MaterialItems = [] if MaterialItems is None else MaterialItems
  86
  87         self._EquipmentItems = []
  88         self.EquipmentItems = [] if EquipmentItems is None else EquipmentItems
  89
  90         self._ContractorItems = []
  91         self.ContractorItems = [] if ContractorItems is None else ContractorItems
  92
  93         self._OverheadCost = None
  94         self.OverheadCost = OverheadCost
  95
  96         self._CostType = None
  97         self.CostType = CostType
  98
  99         super(WorkCostDetail, self).__init__(*args, **kw_args)
 100
 101     _attrs = ["type", "isDebit", "transactionDateTime", "amount"]
 102     _attr_types = {"type": str, "isDebit": bool, "transactionDateTime": str, "amount": float}
 103     _defaults = {"type": '', "isDebit": False, "transactionDateTime": '', "amount": 0.0}
 104     _enums = {}
 105     _refs = ["WorkTask", "Works", "Design", "MiscCostItems", "WorkCostSummary", "PropertyUnits", "ErpProjectAccounting", "LaborItems", "MaterialItems", "EquipmentItems", "ContractorItems", "OverheadCost", "CostType"]
 106     _many_refs = ["Works", "MiscCostItems", "PropertyUnits", "LaborItems", "MaterialItems", "EquipmentItems", "ContractorItems"]
 107
 108     def getWorkTask(self):
 109
 110         return self._WorkTask
 111
 112     def setWorkTask(self, value):
 113         if self._WorkTask is not None:
 114             filtered = [x for x in self.WorkTask.WorkCostDetails if x != self]
 115             self._WorkTask._WorkCostDetails = filtered
 116
 117         self._WorkTask = value
 118         if self._WorkTask is not None:
 119             if self not in self._WorkTask._WorkCostDetails:
 120                 self._WorkTask._WorkCostDetails.append(self)
 121
 122     WorkTask = property(getWorkTask, setWorkTask)
 123
 124     def getWorks(self):
 125
 126         return self._Works
 127
 128     def setWorks(self, value):
 129         for p in self._Works:
 130             filtered = [q for q in p.WorkCostDetails if q != self]
 131             self._Works._WorkCostDetails = filtered
 132         for r in value:
 133             if self not in r._WorkCostDetails:
 134                 r._WorkCostDetails.append(self)
 135         self._Works = value
 136
 137     Works = property(getWorks, setWorks)
 138
 139     def addWorks(self, *Works):
 140         for obj in Works:
 141             if self not in obj._WorkCostDetails:
 142                 obj._WorkCostDetails.append(self)
 143             self._Works.append(obj)
 144
 145     def removeWorks(self, *Works):
 146         for obj in Works:
 147             if self in obj._WorkCostDetails:
 148                 obj._WorkCostDetails.remove(self)
 149             self._Works.remove(obj)
 150
 151     def getDesign(self):
 152
 153         return self._Design
 154
 155     def setDesign(self, value):
 156         if self._Design is not None:
 157             filtered = [x for x in self.Design.WorkCostDetails if x != self]
 158             self._Design._WorkCostDetails = filtered
 159
 160         self._Design = value
 161         if self._Design is not None:
 162             if self not in self._Design._WorkCostDetails:
 163                 self._Design._WorkCostDetails.append(self)
 164
 165     Design = property(getDesign, setDesign)
 166
 167     def getMiscCostItems(self):
 168
 169         return self._MiscCostItems
 170
 171     def setMiscCostItems(self, value):
 172         for x in self._MiscCostItems:
 173             x.WorkCostDetail = None
 174         for y in value:
 175             y._WorkCostDetail = self
 176         self._MiscCostItems = value
 177
 178     MiscCostItems = property(getMiscCostItems, setMiscCostItems)
 179
 180     def addMiscCostItems(self, *MiscCostItems):
 181         for obj in MiscCostItems:
 182             obj.WorkCostDetail = self
 183
 184     def removeMiscCostItems(self, *MiscCostItems):
 185         for obj in MiscCostItems:
 186             obj.WorkCostDetail = None
 187
 188     def getWorkCostSummary(self):
 189
 190         return self._WorkCostSummary
 191
 192     def setWorkCostSummary(self, value):
 193         if self._WorkCostSummary is not None:
 194             self._WorkCostSummary._WorkCostDetail = None
 195
 196         self._WorkCostSummary = value
 197         if self._WorkCostSummary is not None:
 198             self._WorkCostSummary.WorkCostDetail = None
 199             self._WorkCostSummary._WorkCostDetail = self
 200
 201     WorkCostSummary = property(getWorkCostSummary, setWorkCostSummary)
 202
 203     def getPropertyUnits(self):
 204
 205         return self._PropertyUnits
 206
 207     def setPropertyUnits(self, value):
 208         for p in self._PropertyUnits:
 209             filtered = [q for q in p.WorkCostDetails if q != self]
 210             self._PropertyUnits._WorkCostDetails = filtered
 211         for r in value:
 212             if self not in r._WorkCostDetails:
 213                 r._WorkCostDetails.append(self)
 214         self._PropertyUnits = value
 215
 216     PropertyUnits = property(getPropertyUnits, setPropertyUnits)
 217
 218     def addPropertyUnits(self, *PropertyUnits):
 219         for obj in PropertyUnits:
 220             if self not in obj._WorkCostDetails:
 221                 obj._WorkCostDetails.append(self)
 222             self._PropertyUnits.append(obj)
 223
 224     def removePropertyUnits(self, *PropertyUnits):
 225         for obj in PropertyUnits:
 226             if self in obj._WorkCostDetails:
 227                 obj._WorkCostDetails.remove(self)
 228             self._PropertyUnits.remove(obj)
 229
 230     def getErpProjectAccounting(self):
 231
 232         return self._ErpProjectAccounting
 233
 234     def setErpProjectAccounting(self, value):
 235         if self._ErpProjectAccounting is not None:
 236             filtered = [x for x in self.ErpProjectAccounting.WorkCostDetails if x != self]
 237             self._ErpProjectAccounting._WorkCostDetails = filtered
 238
 239         self._ErpProjectAccounting = value
 240         if self._ErpProjectAccounting is not None:
 241             if self not in self._ErpProjectAccounting._WorkCostDetails:
 242                 self._ErpProjectAccounting._WorkCostDetails.append(self)
 243
 244     ErpProjectAccounting = property(getErpProjectAccounting, setErpProjectAccounting)
 245
 246     def getLaborItems(self):
 247
 248         return self._LaborItems
 249
 250     def setLaborItems(self, value):
 251         for x in self._LaborItems:
 252             x.WorkCostDetail = None
 253         for y in value:
 254             y._WorkCostDetail = self
 255         self._LaborItems = value
 256
 257     LaborItems = property(getLaborItems, setLaborItems)
 258
 259     def addLaborItems(self, *LaborItems):
 260         for obj in LaborItems:
 261             obj.WorkCostDetail = self
 262
 263     def removeLaborItems(self, *LaborItems):
 264         for obj in LaborItems:
 265             obj.WorkCostDetail = None
 266
 267     def getMaterialItems(self):
 268
 269         return self._MaterialItems
 270
 271     def setMaterialItems(self, value):
 272         for x in self._MaterialItems:
 273             x.WorkCostDetail = None
 274         for y in value:
 275             y._WorkCostDetail = self
 276         self._MaterialItems = value
 277
 278     MaterialItems = property(getMaterialItems, setMaterialItems)
 279
 280     def addMaterialItems(self, *MaterialItems):
 281         for obj in MaterialItems:
 282             obj.WorkCostDetail = self
 283
 284     def removeMaterialItems(self, *MaterialItems):
 285         for obj in MaterialItems:
 286             obj.WorkCostDetail = None
 287
 288     def getEquipmentItems(self):
 289
 290         return self._EquipmentItems
 291
 292     def setEquipmentItems(self, value):
 293         for x in self._EquipmentItems:
 294             x.WorkCostDetail = None
 295         for y in value:
 296             y._WorkCostDetail = self
 297         self._EquipmentItems = value
 298
 299     EquipmentItems = property(getEquipmentItems, setEquipmentItems)
 300
 301     def addEquipmentItems(self, *EquipmentItems):
 302         for obj in EquipmentItems:
 303             obj.WorkCostDetail = self
 304
 305     def removeEquipmentItems(self, *EquipmentItems):
 306         for obj in EquipmentItems:
 307             obj.WorkCostDetail = None
 308
 309     def getContractorItems(self):
 310
 311         return self._ContractorItems
 312
 313     def setContractorItems(self, value):
 314         for x in self._ContractorItems:
 315             x.WorkCostDetail = None
 316         for y in value:
 317             y._WorkCostDetail = self
 318         self._ContractorItems = value
 319
 320     ContractorItems = property(getContractorItems, setContractorItems)
 321
 322     def addContractorItems(self, *ContractorItems):
 323         for obj in ContractorItems:
 324             obj.WorkCostDetail = self
 325
 326     def removeContractorItems(self, *ContractorItems):
 327         for obj in ContractorItems:
 328             obj.WorkCostDetail = None
 329
 330     def getOverheadCost(self):
 331
 332         return self._OverheadCost
 333
 334     def setOverheadCost(self, value):
 335         if self._OverheadCost is not None:
 336             filtered = [x for x in self.OverheadCost.WorkCostDetails if x != self]
 337             self._OverheadCost._WorkCostDetails = filtered
 338
 339         self._OverheadCost = value
 340         if self._OverheadCost is not None:
 341             if self not in self._OverheadCost._WorkCostDetails:
 342                 self._OverheadCost._WorkCostDetails.append(self)
 343
 344     OverheadCost = property(getOverheadCost, setOverheadCost)
 345
 346     def getCostType(self):
 347
 348         return self._CostType
 349
 350     def setCostType(self, value):
 351         if self._CostType is not None:
 352             filtered = [x for x in self.CostType.WorkCostDetails if x != self]
 353             self._CostType._WorkCostDetails = filtered
 354
 355         self._CostType = value
 356         if self._CostType is not None:
 357             if self not in self._CostType._WorkCostDetails:
 358                 self._CostType._WorkCostDetails.append(self)
 359
 360     CostType = property(getCostType, setCostType)
 361