Package CIM15 :: Package IEC61970 :: Package Core :: Module IdentifiedObject' :: Class IdentifiedObject

Class IdentifiedObject

      object --+    
               |    
Element'.Element --+
                   |
                  IdentifiedObject

Known Subclasses:

This is a root class to provide common identification for all classes needing identification and naming attributesThis is a root class to provide common identification for all classes needing identification and naming attributes

Instance Methods

[hide private]

__init__(self, mRID='', aliasName='', name='', Names=None, DiagramObjects=None, ModelingAuthoritySet=None, *args, **kw_args)
Initialises a new 'IdentifiedObject' instance.

addDiagramObjects(self, *DiagramObjects)

addNames(self, *Names)

getDiagramObjects(self)
The diagram objects that are associated with the domain object

getModelingAuthoritySet(self)
An IdentifiedObject belongs to a Modeling Authority Set for purposes of defining a group of data maintained by the same Modeling Authority.

getNames(self)
All names of this identified object.

removeDiagramObjects(self, *DiagramObjects)

removeNames(self, *Names)

setDiagramObjects(self, value)

setModelingAuthoritySet(self, value)

setNames(self, value)

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

Class Variables

[hide private]

_attr_types = {'aliasName': <type 'str'>, 'mRID': <type 'str'>...

_attrs = ['mRID', 'aliasName', 'name']

_defaults = {'aliasName': '', 'mRID': '', 'name': ''}

_many_refs = ['Names', 'DiagramObjects']

_refs = ['Names', 'DiagramObjects', 'ModelingAuthoritySet']

Inherited from Element'.Element (private): _enums

Properties

[hide private]

DiagramObjects
The diagram objects that are associated with the domain object

ModelingAuthoritySet
An IdentifiedObject belongs to a Modeling Authority Set for purposes of defining a group of data maintained by the same Modeling Authority.

Names
All names of this identified object.

Inherited from object: __class__

Method Details

[hide private]

init(self, mRID=`''`, aliasName=`''`, name=`''`, Names=None, DiagramObjects=None, ModelingAuthoritySet=None, *args, **kw_args)
(Constructor)

Initialises a new 'IdentifiedObject' instance.

Parameters:

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. Global uniqeness is easily achived by using a UUID for the mRID. It is strongly recommended to do this. For CIMXML data files the mRID is mapped to rdf:ID or rdf:about attributes that identifies CIM object elements.
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. The attribute aliasName is put back because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time. This was decided at a joint WG13/14 meeting in Minneapolis 2010-10-06.
name - The name is any free human readable and possibly non unique text naming the object.
Names - All names of this identified object.
DiagramObjects - The diagram objects that are associated with the domain object
ModelingAuthoritySet - An IdentifiedObject belongs to a Modeling Authority Set for purposes of defining a group of data maintained by the same Modeling Authority.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'aliasName': <type 'str'>,
 'mRID': <type 'str'>,
 'name': <type 'str'>}

Property Details

[hide private]

DiagramObjects

The diagram objects that are associated with the domain object

Get Method:: getDiagramObjects(self) - The diagram objects that are associated with the domain object
Set Method:: setDiagramObjects(self, value)

ModelingAuthoritySet

An IdentifiedObject belongs to a Modeling Authority Set for purposes of defining a group of data maintained by the same Modeling Authority.

Get Method:: getModelingAuthoritySet(self) - An IdentifiedObject belongs to a Modeling Authority Set for purposes of defining a group of data maintained by the same Modeling Authority.
Set Method:: setModelingAuthoritySet(self, value)

Names

All names of this identified object.

Get Method:: getNames(self) - All names of this identified object.
Set Method:: setNames(self, value)

Class IdentifiedObject

__init__(self, mRID='', aliasName='', name='', Names=None, DiagramObjects=None, ModelingAuthoritySet=None, *args, **kw_args) (Constructor)

_attr_types

DiagramObjects

ModelingAuthoritySet

Names

init(self, mRID=`''`, aliasName=`''`, name=`''`, Names=None, DiagramObjects=None, ModelingAuthoritySet=None, *args, **kw_args)
(Constructor)