CIM14/IEC61970/Core/IdentifiedObject.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 CIM14.Element import Element
  22
  23 class IdentifiedObject(Element):
  24     """This is a root class to provide common naming attributes for all classes needing naming attributes
  25     """
  26
  27     def __init__(self, pathName='', aliasName='', mRID='', name='', description='', localName='', ModelingAuthoritySet=None, *args, **kw_args):
  28         """Initialises a new 'IdentifiedObject' instance.
  29
  30         @param pathName: The pathname is a system unique name composed from all IdentifiedObject.localNames in a naming hierarchy path from the object to the root.
  31         @param aliasName: The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
  32         @param mRID: A Model Authority issues mRIDs. Given that each Model Authority has a unique id and this id is part of the mRID, then the mRID is globally unique.
  33         @param name: The name is a free text human readable name of the object. It may be non unique and may not correlate to a naming hierarchy.
  34         @param description: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.
  35         @param localName: The localName is a human readable name of the object. It is only used with objects organized in a naming hierarchy. The simplest naming hierarchy has just one parent (the root) giving a flat naming hierarchy. However, the naming hierarchy usually has several levels, e.g. Substation, VoltageLevel, Equipment etc. Children of the same parent have names that are unique among them. If the uniqueness requirement cannot be met IdentifiedObject.localName shall not be used, use IdentifiedObject.name  instead.
  36         @param ModelingAuthoritySet: An IdentifiedObject belongs to a Modeling Authority Set for purposes of defining a group of data maintained by the same Modeling Authority.
  37         """
  38         #: The pathname is a system unique name composed from all IdentifiedObject.localNames in a naming hierarchy path from the object to the root.
  39         self.pathName = pathName
  40
  41         #: The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
  42         self.aliasName = aliasName
  43
  44         #: A Model Authority issues mRIDs. Given that each Model Authority has a unique id and this id is part of the mRID, then the mRID is globally unique.
  45         self.mRID = mRID
  46
  47         #: The name is a free text human readable name of the object. It may be non unique and may not correlate to a naming hierarchy.
  48         self.name = name
  49
  50         #: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.
  51         self.description = description
  52
  53         #: The localName is a human readable name of the object. It is only used with objects organized in a naming hierarchy. The simplest naming hierarchy has just one parent (the root) giving a flat naming hierarchy. However, the naming hierarchy usually has several levels, e.g. Substation, VoltageLevel, Equipment etc. Children of the same parent have names that are unique among them. If the uniqueness requirement cannot be met IdentifiedObject.localName shall not be used, use IdentifiedObject.name  instead.
  54         self.localName = localName
  55
  56         self._ModelingAuthoritySet = None
  57         self.ModelingAuthoritySet = ModelingAuthoritySet
  58
  59         super(IdentifiedObject, self).__init__(*args, **kw_args)
  60
  61     _attrs = ["pathName", "aliasName", "mRID", "name", "description", "localName"]
  62     _attr_types = {"pathName": str, "aliasName": str, "mRID": str, "name": str, "description": str, "localName": str}
  63     _defaults = {"pathName": '', "aliasName": '', "mRID": '', "name": '', "description": '', "localName": ''}
  64     _enums = {}
  65     _refs = ["ModelingAuthoritySet"]
  66     _many_refs = []
  67
  68     def getModelingAuthoritySet(self):
  69         """An IdentifiedObject belongs to a Modeling Authority Set for purposes of defining a group of data maintained by the same Modeling Authority.
  70         """
  71         return self._ModelingAuthoritySet
  72
  73     def setModelingAuthoritySet(self, value):
  74         if self._ModelingAuthoritySet is not None:
  75             filtered = [x for x in self.ModelingAuthoritySet.IdentifiedObjects if x != self]
  76             self._ModelingAuthoritySet._IdentifiedObjects = filtered
  77
  78         self._ModelingAuthoritySet = value
  79         if self._ModelingAuthoritySet is not None:
  80             if self not in self._ModelingAuthoritySet._IdentifiedObjects:
  81                 self._ModelingAuthoritySet._IdentifiedObjects.append(self)
  82
  83     ModelingAuthoritySet = property(getModelingAuthoritySet, setModelingAuthoritySet)
  84