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, description='', name='', aliasName='', pathName='', *args, **kw_args)
Initialises a new 'IdentifiedObject' instance.

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 = ['description', 'name', 'aliasName', 'pathName']

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

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

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

Initialises a new 'IdentifiedObject' instance.

Parameters:

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.
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.The name attribute is required except for the following classes: FossilFuel, HydorPump, LoadResponseCharacteristic, MutualCoupling, ReactiveCapabilityCurve, RegulatingControl, SynchronousMachine, TopologicalIsland, ConductingEquipment, Conductor, ConnectivityNodeContainer, Curve, Equipment, EquipmentContainer, EquivalentEquipment, REgulatingCondEq, TapChanger, BaseVoltage, Terminal, TransformerWinding, RatioTapChanger, PhaseTapChanger, OperationalLimitSet, CurrentLimit, and VoltageLimit.
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.
pathName - The pathname is a system unique name composed from all IdentifiedObject.localNames in a naming hierarchy path from the object to the root.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'aliasName': <type 'str'>,
 'description': <type 'str'>,
 'name': <type 'str'>,
 'pathName': <type 'str'>}

_defaults

Value:

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

Class IdentifiedObject

__init__(self, description='', name='', aliasName='', pathName='', *args, **kw_args) (Constructor)

_attr_types

_defaults

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