Package CIM15 :: Package IEC61968 :: Package Common :: Module Document' :: Class Document

Class Document

                                  object --+        
                                           |        
                            Element'.Element --+    
                                               |    
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+
                                                   |
                                                  Document

Known Subclasses:

Parent class for different groupings of information collected and managed as a part of a business process. It will frequently contain references to other objects, such as assets, people and power system resources.Parent class for different groupings of information collected and managed as a part of a business process. It will frequently contain references to other objects, such as assets, people and power system resources.

Instance Methods

[hide private]

__init__(self, revisionNumber='', createdDateTime='', lastModifiedDateTime='', subject='', title='', category='', ChangeItems=None, ToDocumentRoles=None, electronicAddress=None, NetworkDataSets=None, FromDocumentRoles=None, ScheduleParameterInfos=None, ErpOrganisationRoles=None, Measurements=None, ActivityRecords=None, ChangeSets=None, ErpPersonRoles=None, ScheduledEvents=None, docStatus=None, AssetRoles=None, status=None, PowerSystemResourceRoles=None, *args, **kw_args)
Initialises a new 'Document' instance.

addActivityRecords(self, *ActivityRecords)

addAssetRoles(self, *AssetRoles)

addChangeItems(self, *ChangeItems)

addChangeSets(self, *ChangeSets)

addErpOrganisationRoles(self, *ErpOrganisationRoles)

addErpPersonRoles(self, *ErpPersonRoles)

addFromDocumentRoles(self, *FromDocumentRoles)

addMeasurements(self, *Measurements)

addNetworkDataSets(self, *NetworkDataSets)

addPowerSystemResourceRoles(self, *PowerSystemResourceRoles)

addScheduleParameterInfos(self, *ScheduleParameterInfos)

addScheduledEvents(self, *ScheduledEvents)

addToDocumentRoles(self, *ToDocumentRoles)

getActivityRecords(self)
All activity records created for this document.

getAssetRoles(self)

getChangeItems(self)

getChangeSets(self)

getErpOrganisationRoles(self)

getErpPersonRoles(self)

getFromDocumentRoles(self)

getMeasurements(self)
Measurements are specified in types of documents, such as procedures.

getNetworkDataSets(self)

getPowerSystemResourceRoles(self)

getScheduleParameterInfos(self)

getScheduledEvents(self)

getToDocumentRoles(self)

removeActivityRecords(self, *ActivityRecords)

removeAssetRoles(self, *AssetRoles)

removeChangeItems(self, *ChangeItems)

removeChangeSets(self, *ChangeSets)

removeErpOrganisationRoles(self, *ErpOrganisationRoles)

removeErpPersonRoles(self, *ErpPersonRoles)

removeFromDocumentRoles(self, *FromDocumentRoles)

removeMeasurements(self, *Measurements)

removeNetworkDataSets(self, *NetworkDataSets)

removePowerSystemResourceRoles(self, *PowerSystemResourceRoles)

removeScheduleParameterInfos(self, *ScheduleParameterInfos)

removeScheduledEvents(self, *ScheduledEvents)

removeToDocumentRoles(self, *ToDocumentRoles)

setActivityRecords(self, value)

setAssetRoles(self, value)

setChangeItems(self, value)

setChangeSets(self, value)

setErpOrganisationRoles(self, value)

setErpPersonRoles(self, value)

setFromDocumentRoles(self, value)

setMeasurements(self, value)

setNetworkDataSets(self, value)

setPowerSystemResourceRoles(self, value)

setScheduleParameterInfos(self, value)

setScheduledEvents(self, value)

setToDocumentRoles(self, value)

Inherited from IEC61970.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 = {'category': <type 'str'>, 'createdDateTime': <t...

_attrs = ['revisionNumber', 'createdDateTime', 'lastModifiedDa...

_defaults = {'category': '', 'createdDateTime': '', 'lastModif...

_many_refs = ['ChangeItems', 'ToDocumentRoles', 'NetworkDataSe...

_refs = ['ChangeItems', 'ToDocumentRoles', 'electronicAddress'...

docStatus = None

electronicAddress = None

status = None

Inherited from Element'.Element (private): _enums

Properties

[hide private]

ActivityRecords
All activity records created for this document.

AssetRoles

ChangeItems

ChangeSets

ErpOrganisationRoles

ErpPersonRoles

FromDocumentRoles

Measurements
Measurements are specified in types of documents, such as procedures.

NetworkDataSets

PowerSystemResourceRoles

ScheduleParameterInfos

ScheduledEvents

ToDocumentRoles

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

Inherited from object: __class__

Method Details

[hide private]

init(self, revisionNumber=`''`, createdDateTime=`''`, lastModifiedDateTime=`''`, subject=`''`, title=`''`, category=`''`, ChangeItems=None, ToDocumentRoles=None, electronicAddress=None, NetworkDataSets=None, FromDocumentRoles=None, ScheduleParameterInfos=None, ErpOrganisationRoles=None, Measurements=None, ActivityRecords=None, ChangeSets=None, ErpPersonRoles=None, ScheduledEvents=None, docStatus=None, AssetRoles=None, status=None, PowerSystemResourceRoles=None, *args, **kw_args)
(Constructor)

Initialises a new 'Document' instance.

Parameters:

revisionNumber - Revision number for this document.
createdDateTime - Date and time that this document was created.
lastModifiedDateTime - Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.
subject - Document subject.
title - Document title.
category - Utility-specific categorisation of this document, according to their corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).
ChangeItems
ToDocumentRoles
electronicAddress - Electronic address.
NetworkDataSets
FromDocumentRoles
ScheduleParameterInfos
ErpOrganisationRoles
Measurements - Measurements are specified in types of documents, such as procedures.
ActivityRecords - All activity records created for this document.
ChangeSets
ErpPersonRoles
ScheduledEvents
docStatus - Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute. Example values for 'docStatus.status' are draft, approved, cancelled, etc.
AssetRoles
status - Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.
PowerSystemResourceRoles

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'category': <type 'str'>,
 'createdDateTime': <type 'str'>,
 'lastModifiedDateTime': <type 'str'>,
 'revisionNumber': <type 'str'>,
 'subject': <type 'str'>,
 'title': <type 'str'>}

_attrs

Value:

['revisionNumber',
 'createdDateTime',
 'lastModifiedDateTime',
 'subject',
 'title',
 'category']

_defaults

Value:

{'category': '',
 'createdDateTime': '',
 'lastModifiedDateTime': '',
 'revisionNumber': '',
 'subject': '',
 'title': ''}

_many_refs

Value:

['ChangeItems',
 'ToDocumentRoles',
 'NetworkDataSets',
 'FromDocumentRoles',
 'ScheduleParameterInfos',
 'ErpOrganisationRoles',
 'Measurements',
 'ActivityRecords',
...

_refs

Value:

['ChangeItems',
 'ToDocumentRoles',
 'electronicAddress',
 'NetworkDataSets',
 'FromDocumentRoles',
 'ScheduleParameterInfos',
 'ErpOrganisationRoles',
 'Measurements',
...

Property Details

[hide private]

ActivityRecords

All activity records created for this document.

Get Method:: getActivityRecords(self) - All activity records created for this document.
Set Method:: setActivityRecords(self, value)

AssetRoles

Get Method:: getAssetRoles(self)
Set Method:: setAssetRoles(self, value)

ChangeItems

Get Method:: getChangeItems(self)
Set Method:: setChangeItems(self, value)

ChangeSets

Get Method:: getChangeSets(self)
Set Method:: setChangeSets(self, value)

ErpOrganisationRoles

Get Method:: getErpOrganisationRoles(self)
Set Method:: setErpOrganisationRoles(self, value)

ErpPersonRoles

Get Method:: getErpPersonRoles(self)
Set Method:: setErpPersonRoles(self, value)

FromDocumentRoles

Get Method:: getFromDocumentRoles(self)
Set Method:: setFromDocumentRoles(self, value)

Measurements

Measurements are specified in types of documents, such as procedures.

Get Method:: getMeasurements(self) - Measurements are specified in types of documents, such as procedures.
Set Method:: setMeasurements(self, value)

NetworkDataSets

Get Method:: getNetworkDataSets(self)
Set Method:: setNetworkDataSets(self, value)

PowerSystemResourceRoles

Get Method:: getPowerSystemResourceRoles(self)
Set Method:: setPowerSystemResourceRoles(self, value)

ScheduleParameterInfos

Get Method:: getScheduleParameterInfos(self)
Set Method:: setScheduleParameterInfos(self, value)

ScheduledEvents

Get Method:: getScheduledEvents(self)
Set Method:: setScheduledEvents(self, value)

ToDocumentRoles

Get Method:: getToDocumentRoles(self)
Set Method:: setToDocumentRoles(self, value)