Class NameType

      object --+    
               |    
Element'.Element --+
                   |
                  NameType

Type of name. Possible values for attribute 'name' are implementation dependent but standard profiles may specify types. An enterprise may have multiple IT systems each having its own local name for the same object, e.g. a planning system may have different names from an EMS. An object may also have different names within the same IT system, e.g. localName and aliasName as defined in CIM version 14. Their definitions from CIM14 are The localName is a human readable name of the object. It is only used with objects organized in a naming hierarchy. localName: A free text name local to a node in a naming hierarchy similar to a file directory structure. A power system related naming hierarchy may be: Substation, VoltageLevel, Equipment etc. Children of the same parent in such a hierarchy have names that typically are unique among them. aliasName: A free text alternate name typically used in tabular reports where the column width is limited.

Instance Methods

[hide private]

__init__(self, name='', description='', NameTypeAuthority=None, Names=None, *args, **kw_args)
Initialises a new 'NameType' instance.

addNames(self, *Names)

getNameTypeAuthority(self)
Authority responsible for managing names of this type.

getNames(self)
All names of this type.

removeNames(self, *Names)

setNameTypeAuthority(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 = {'description': <type 'str'>, 'name': <type 'str'>}

_attrs = ['name', 'description']

_defaults = {'description': '', 'name': ''}

_many_refs = ['Names']

_refs = ['NameTypeAuthority', 'Names']

Inherited from Element'.Element (private): _enums

Properties

[hide private]

NameTypeAuthority
Authority responsible for managing names of this type.

Names
All names of this type.

Inherited from object: __class__

Method Details

[hide private]

init(self, name=`''`, description=`''`, NameTypeAuthority=None, Names=None, *args, **kw_args)
(Constructor)

Initialises a new 'NameType' instance.

Parameters:

name - Name of the name type.
description - Description of the name type.
NameTypeAuthority - Authority responsible for managing names of this type.
Names - All names of this type.

Overrides: object.__init__

Property Details

[hide private]

NameTypeAuthority

Authority responsible for managing names of this type.

Get Method:: getNameTypeAuthority(self) - Authority responsible for managing names of this type.
Set Method:: setNameTypeAuthority(self, value)

Names

All names of this type.

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

Class NameType

__init__(self, name='', description='', NameTypeAuthority=None, Names=None, *args, **kw_args) (Constructor)

NameTypeAuthority

Names

init(self, name=`''`, description=`''`, NameTypeAuthority=None, Names=None, *args, **kw_args)
(Constructor)