Package CIM14 :: 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.

Instance Methods

[hide private]

__init__(self, revisionNumber='', subject='', createdDateTime='', title='', category='', lastModifiedDateTime='', electronicAddress=None, status=None, ActivityRecords=None, docStatus=None, Measurements=None, *args, **kw_args)
Initialises a new 'Document' instance.

addActivityRecords(self, *ActivityRecords)

addMeasurements(self, *Measurements)

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

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

removeActivityRecords(self, *ActivityRecords)

removeMeasurements(self, *Measurements)

setActivityRecords(self, value)

setMeasurements(self, value)

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

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', 'subject', 'createdDateTime', 'tit...

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

_many_refs = ['ActivityRecords', 'Measurements']

_refs = ['electronicAddress', 'status', 'ActivityRecords', 'do...

docStatus = None

electronicAddress = None

status = None

Inherited from Element'.Element (private): _enums

Properties

[hide private]

ActivityRecords
All activity records created for this document.

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

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details

[hide private]

init(self, revisionNumber=`''`, subject=`''`, createdDateTime=`''`, title=`''`, category=`''`, lastModifiedDateTime=`''`, electronicAddress=None, status=None, ActivityRecords=None, docStatus=None, Measurements=None, *args, **kw_args)
(Constructor)

Initialises a new 'Document' instance.

Parameters:

revisionNumber - Revision number for this document.
subject - Document subject.
createdDateTime - Date and time that this document was created.
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.).
lastModifiedDateTime - Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.
electronicAddress - Electronic address.
status - Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.
ActivityRecords - All activity records created for this document.
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.
Measurements - Measurements are specified in types of documents, such as procedures.

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',
 'subject',
 'createdDateTime',
 'title',
 'category',
 'lastModifiedDateTime']

_defaults

Value:

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

_refs

Value:

['electronicAddress',
 'status',
 'ActivityRecords',
 'docStatus',
 '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)

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)

Class Document

__init__(self, revisionNumber='', subject='', createdDateTime='', title='', category='', lastModifiedDateTime='', electronicAddress=None, status=None, ActivityRecords=None, docStatus=None, Measurements=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

_refs

ActivityRecords

Measurements

init(self, revisionNumber=`''`, subject=`''`, createdDateTime=`''`, title=`''`, category=`''`, lastModifiedDateTime=`''`, electronicAddress=None, status=None, ActivityRecords=None, docStatus=None, Measurements=None, *args, **kw_args)
(Constructor)