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

Class IdentifiedObject

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

Known Subclasses:

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

Instance Methods

[hide private]

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

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

setModelingAuthoritySet(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'>, 'description': <type...

_attrs = ['pathName', 'aliasName', 'mRID', 'name', 'descriptio...

_defaults = {'aliasName': '', 'description': '', 'localName': ...

_refs = ['ModelingAuthoritySet']

Inherited from Element'.Element (private): _enums, _many_refs

Properties

[hide private]

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

Inherited from object: __class__

Method Details

[hide private]

init(self, pathName=`''`, aliasName=`''`, mRID=`''`, name=`''`, description=`''`, localName=`''`, ModelingAuthoritySet=None, *args, **kw_args)
(Constructor)

Initialises a new 'IdentifiedObject' instance.

Parameters:

pathName - The pathname is a system unique name composed from all IdentifiedObject.localNames in a naming hierarchy path from the object to the root.
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.
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.
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.
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.
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.
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'>,
 'description': <type 'str'>,
 'localName': <type 'str'>,
 'mRID': <type 'str'>,
 'name': <type 'str'>,
 'pathName': <type 'str'>}

_attrs

Value:

['pathName', 'aliasName', 'mRID', 'name', 'description', 'localName']

_defaults

Value:

{'aliasName': '',
 'description': '',
 'localName': '',
 'mRID': '',
 'name': '',
 'pathName': ''}

Property Details

[hide private]

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)

Class IdentifiedObject

__init__(self, pathName='', aliasName='', mRID='', name='', description='', localName='', ModelingAuthoritySet=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

ModelingAuthoritySet

init(self, pathName=`''`, aliasName=`''`, mRID=`''`, name=`''`, description=`''`, localName=`''`, ModelingAuthoritySet=None, *args, **kw_args)
(Constructor)