Class Name

      object --+    
               |    
Element'.Element --+
                   |
                  Name

The Name class provides the means to define any number of human readable names for an object. A name is <b>not</b> to be used for defining inter-object relationships. For inter-object relationships instead use the object identification 'mRID'.

Instance Methods

[hide private]

__init__(self, name='', NameType=None, IdentifiedObject=None, *args, **kw_args)
Initialises a new 'Name' instance.

getIdentifiedObject(self)
Identified object that this name designates.

getNameType(self)
Type of this name.

setIdentifiedObject(self, value)

setNameType(self, value)

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

Class Variables

[hide private]

_attr_types = {'name': <type 'str'>}

_attrs = ['name']

_defaults = {'name': ''}

_refs = ['NameType', 'IdentifiedObject']

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

Properties

[hide private]

IdentifiedObject
Identified object that this name designates.

NameType
Type of this name.

Inherited from object: __class__

Method Details

[hide private]

init(self, name=`''`, NameType=None, IdentifiedObject=None, *args, **kw_args)
(Constructor)

Initialises a new 'Name' instance.

Parameters:

name - Any free text that name the object.
NameType - Type of this name.
IdentifiedObject - Identified object that this name designates.

Overrides: object.__init__

Property Details

[hide private]

IdentifiedObject

Identified object that this name designates.

Get Method:: getIdentifiedObject(self) - Identified object that this name designates.
Set Method:: setIdentifiedObject(self, value)

NameType

Type of this name.

Get Method:: getNameType(self) - Type of this name.
Set Method:: setNameType(self, value)

Class Name

__init__(self, name='', NameType=None, IdentifiedObject=None, *args, **kw_args) (Constructor)

IdentifiedObject

NameType

init(self, name=`''`, NameType=None, IdentifiedObject=None, *args, **kw_args)
(Constructor)