schemata/CIM14/IEC61968/Common/Document.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.IdentifiedObject import IdentifiedObject
  18
  19 class Document(IdentifiedObject):
  20     """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.
  21     """
  22
  23     def __init__(self, revisionNumber='', subject='', createdDateTime='', title='', category='', lastModifiedDateTime='', electronicAddress=None, status=None, ActivityRecords=None, docStatus=None, Measurements=None, *args, **kw_args):
  24         """Initialises a new 'Document' instance.
  25
  26         @param revisionNumber: Revision number for this document.
  27         @param subject: Document subject.
  28         @param createdDateTime: Date and time that this document was created.
  29         @param title: Document title.
  30         @param 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.).
  31         @param lastModifiedDateTime: Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.
  32         @param electronicAddress: Electronic address.
  33         @param status: Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.
  34         @param ActivityRecords: All activity records created for this document.
  35         @param 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.
  36         @param Measurements: Measurements are specified in types of documents, such as procedures.
  37         """
  38         #: Revision number for this document.
  39         self.revisionNumber = revisionNumber
  40
  41         #: Document subject.
  42         self.subject = subject
  43
  44         #: Date and time that this document was created.
  45         self.createdDateTime = createdDateTime
  46
  47         #: Document title.
  48         self.title = title
  49
  50         #: 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.).
  51         self.category = category
  52
  53         #: Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.
  54         self.lastModifiedDateTime = lastModifiedDateTime
  55
  56         self.electronicAddress = electronicAddress
  57
  58         self.status = status
  59
  60         self._ActivityRecords = []
  61         self.ActivityRecords = [] if ActivityRecords is None else ActivityRecords
  62
  63         self.docStatus = docStatus
  64
  65         self._Measurements = []
  66         self.Measurements = [] if Measurements is None else Measurements
  67
  68         super(Document, self).__init__(*args, **kw_args)
  69
  70     _attrs = ["revisionNumber", "subject", "createdDateTime", "title", "category", "lastModifiedDateTime"]
  71     _attr_types = {"revisionNumber": str, "subject": str, "createdDateTime": str, "title": str, "category": str, "lastModifiedDateTime": str}
  72     _defaults = {"revisionNumber": '', "subject": '', "createdDateTime": '', "title": '', "category": '', "lastModifiedDateTime": ''}
  73     _enums = {}
  74     _refs = ["electronicAddress", "status", "ActivityRecords", "docStatus", "Measurements"]
  75     _many_refs = ["ActivityRecords", "Measurements"]
  76
  77     # Electronic address.
  78     electronicAddress = None
  79
  80     # Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.
  81     status = None
  82
  83     def getActivityRecords(self):
  84         """All activity records created for this document.
  85         """
  86         return self._ActivityRecords
  87
  88     def setActivityRecords(self, value):
  89         for p in self._ActivityRecords:
  90             filtered = [q for q in p.Documents if q != self]
  91             self._ActivityRecords._Documents = filtered
  92         for r in value:
  93             if self not in r._Documents:
  94                 r._Documents.append(self)
  95         self._ActivityRecords = value
  96
  97     ActivityRecords = property(getActivityRecords, setActivityRecords)
  98
  99     def addActivityRecords(self, *ActivityRecords):
 100         for obj in ActivityRecords:
 101             if self not in obj._Documents:
 102                 obj._Documents.append(self)
 103             self._ActivityRecords.append(obj)
 104
 105     def removeActivityRecords(self, *ActivityRecords):
 106         for obj in ActivityRecords:
 107             if self in obj._Documents:
 108                 obj._Documents.remove(self)
 109             self._ActivityRecords.remove(obj)
 110
 111     # 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.
 112     docStatus = None
 113
 114     def getMeasurements(self):
 115         """Measurements are specified in types of documents, such as procedures.
 116         """
 117         return self._Measurements
 118
 119     def setMeasurements(self, value):
 120         for p in self._Measurements:
 121             filtered = [q for q in p.Documents if q != self]
 122             self._Measurements._Documents = filtered
 123         for r in value:
 124             if self not in r._Documents:
 125                 r._Documents.append(self)
 126         self._Measurements = value
 127
 128     Measurements = property(getMeasurements, setMeasurements)
 129
 130     def addMeasurements(self, *Measurements):
 131         for obj in Measurements:
 132             if self not in obj._Documents:
 133                 obj._Documents.append(self)
 134             self._Measurements.append(obj)
 135
 136     def removeMeasurements(self, *Measurements):
 137         for obj in Measurements:
 138             if self in obj._Documents:
 139                 obj._Documents.remove(self)
 140             self._Measurements.remove(obj)
 141