Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfWork :: Module TypeMaterial' :: Class TypeMaterial
[hide private]
[frames] | no frames]

Class TypeMaterial

                         object --+            
                                  |            
                   Element'.Element --+        
                                      |        
Core.IdentifiedObject'.IdentifiedObject --+    
                                          |    
         IEC61968.Common.Document'.Document --+
                                              |
                                             TypeMaterial

Documentation for a generic material item that may be used for design, work and other purposes. Any number of MaterialItems manufactured by various vendors may be used to perform this TypeMaterial. Note that class analagous to 'AssetModel' is not used for material items. This is because in some cases, for example, a utility sets up a Master material record for a 3 inch long half inch diameter steel bolt and they do not necessarily care what specific supplier is providing the material item. As different vendors are used to supply the part, the Stock Code of the material item can stay the same. In other cases, each time the vendor changes, a new stock code is set up so they can track material used by vendor. Therefore a Material Item 'Model' is not typically needed.Documentation for a generic material item that may be used for design, work and other purposes. Any number of MaterialItems manufactured by various vendors may be used to perform this TypeMaterial. Note that class analagous to 'AssetModel' is not used for material items. This is because in some cases, for example, a utility sets up a Master material record for a 3 inch long half inch diameter steel bolt and they do not necessarily care what specific supplier is providing the material item. As different vendors are used to supply the part, the Stock Code of the material item can stay the same. In other cases, each time the vendor changes, a new stock code is set up so they can track material used by vendor. Therefore a Material Item 'Model' is not typically needed.

Instance Methods [hide private]
 
__init__(self, stockItem=False, costType='', quantity='', estUnitCost=0.0, ErpIssueInventories=None, MaterialItems=None, CUMaterialItems=None, ErpReqLineItems=None, *args, **kw_args)
Initialises a new 'TypeMaterial' instance.
 
addCUMaterialItems(self, *CUMaterialItems)
 
addErpIssueInventories(self, *ErpIssueInventories)
 
addErpReqLineItems(self, *ErpReqLineItems)
 
addMaterialItems(self, *MaterialItems)
 
getCUMaterialItems(self)
 
getErpIssueInventories(self)
 
getErpReqLineItems(self)
 
getMaterialItems(self)
 
removeCUMaterialItems(self, *CUMaterialItems)
 
removeErpIssueInventories(self, *ErpIssueInventories)
 
removeErpReqLineItems(self, *ErpReqLineItems)
 
removeMaterialItems(self, *MaterialItems)
 
setCUMaterialItems(self, value)
 
setErpIssueInventories(self, value)
 
setErpReqLineItems(self, value)
 
setMaterialItems(self, value)

Inherited from IEC61968.Common.Document'.Document: addActivityRecords, addAssetRoles, addChangeItems, addChangeSets, addErpOrganisationRoles, addErpPersonRoles, addFromDocumentRoles, addMeasurements, addNetworkDataSets, addPowerSystemResourceRoles, addScheduleParameterInfos, addScheduledEvents, addToDocumentRoles, getActivityRecords, getAssetRoles, getChangeItems, getChangeSets, getErpOrganisationRoles, getErpPersonRoles, getFromDocumentRoles, getMeasurements, getNetworkDataSets, getPowerSystemResourceRoles, getScheduleParameterInfos, getScheduledEvents, getToDocumentRoles, removeActivityRecords, removeAssetRoles, removeChangeItems, removeChangeSets, removeErpOrganisationRoles, removeErpPersonRoles, removeFromDocumentRoles, removeMeasurements, removeNetworkDataSets, removePowerSystemResourceRoles, removeScheduleParameterInfos, removeScheduledEvents, removeToDocumentRoles, setActivityRecords, setAssetRoles, setChangeItems, setChangeSets, setErpOrganisationRoles, setErpPersonRoles, setFromDocumentRoles, setMeasurements, setNetworkDataSets, setPowerSystemResourceRoles, setScheduleParameterInfos, setScheduledEvents, setToDocumentRoles

Inherited from Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'costType': <type 'str'>, 'estUnitCost': <type ...
  _attrs = ['stockItem', 'costType', 'quantity', 'estUnitCost']
  _defaults = {'costType': '', 'estUnitCost': 0.0, 'quantity': '...
  _many_refs = ['ErpIssueInventories', 'MaterialItems', 'CUMater...
  _refs = ['ErpIssueInventories', 'MaterialItems', 'CUMaterialIt...

Inherited from IEC61968.Common.Document'.Document: docStatus, electronicAddress, status

Inherited from Element'.Element (private): _enums

Properties [hide private]
  CUMaterialItems
  ErpIssueInventories
  ErpReqLineItems
  MaterialItems

Inherited from IEC61968.Common.Document'.Document: ActivityRecords, AssetRoles, ChangeItems, ChangeSets, ErpOrganisationRoles, ErpPersonRoles, FromDocumentRoles, Measurements, NetworkDataSets, PowerSystemResourceRoles, ScheduleParameterInfos, ScheduledEvents, ToDocumentRoles

Inherited from Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details [hide private]

__init__(self, stockItem=False, costType='', quantity='', estUnitCost=0.0, ErpIssueInventories=None, MaterialItems=None, CUMaterialItems=None, ErpReqLineItems=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'TypeMaterial' instance.

Parameters:
  • stockItem - True if item is a stock item (default).
  • costType - The category of cost to which this Material Item belongs.
  • quantity - The value, unit of measure, and multiplier for the quantity.
  • estUnitCost - The estimated unit cost of this type of material, either for a unit cost or cost per unit length. Cost is for material or asset only and does not include labor to install/construct or configure it.
  • ErpIssueInventories
  • MaterialItems
  • CUMaterialItems
  • ErpReqLineItems
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'costType': <type 'str'>,
 'estUnitCost': <type 'float'>,
 'quantity': <type 'str'>,
 'stockItem': <type 'bool'>}

_defaults

Value:
{'costType': '',
 'estUnitCost': 0.0,
 'quantity': '',
 'stockItem': False}

_many_refs

Value:
['ErpIssueInventories',
 'MaterialItems',
 'CUMaterialItems',
 'ErpReqLineItems']

_refs

Value:
['ErpIssueInventories',
 'MaterialItems',
 'CUMaterialItems',
 'ErpReqLineItems']

Property Details [hide private]

CUMaterialItems

Get Method:
getCUMaterialItems(self)
Set Method:
setCUMaterialItems(self, value)

ErpIssueInventories

Get Method:
getErpIssueInventories(self)
Set Method:
setErpIssueInventories(self, value)

ErpReqLineItems

Get Method:
getErpReqLineItems(self)
Set Method:
setErpReqLineItems(self, value)

MaterialItems

Get Method:
getMaterialItems(self)
Set Method:
setMaterialItems(self, value)