Package CIM14 :: Package Dynamics :: Module AttributeBlockParameter' :: Class AttributeBlockParameter

[frames] | no frames]

Class AttributeBlockParameter

                                  object --+                
                                           |                
                            Element'.Element --+            
                                               |            
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+        
                                                   |        
          MetaBlockConnectable'.MetaBlockConnectable --+    
                                                       |    
                  MetaBlockParameter'.MetaBlockParameter --+
                                                           |
                                                          AttributeBlockParameter

An attribute from the associated PowerSystemResource is used. This is like reflection into the UML model as one must name the paramter the same as the CIM name of the desired attribute. Such parameters are not important for completely standard models as the relation to the CIM attributes is fixed. This object is required for user defined models that use attributes already existing on the PowerSystemResource or its derived classes. Using this class avoids creating new paramter instances (with values) when we already have the values as class attributes of the associated PowerSystemResource. Standard block models might optinally use objects of this class to convey information about the internals of the standard block.

Instance Methods

__init__(self, attributeName='', *args, **kw_args)
Initialises a new 'AttributeBlockParameter' instance.

Inherited from MetaBlockParameter'.MetaBlockParameter: addBlockParameter, getBlockParameter, getMemberOf_MetaBlock, removeBlockParameter, setBlockParameter, setMemberOf_MetaBlock

Inherited from MetaBlockConnectable'.MetaBlockConnectable: addBlockInputReference, addMetaBlockInputReference, addMetaBlockOutputReference, addMetaBlockParameterReference, addMetaBlockStateReference, addStandardControlBlock_MetaBlockInputReference, addStandardControlBlock_MetaBlockOutputReference, addStandardControlBlock_MetaBlockParameterReference, addStandardControlBlock_MetaBlockStateReference, getBlockInputReference, getMetaBlockInputReference, getMetaBlockOutputReference, getMetaBlockParameterReference, getMetaBlockStateReference, getStandardControlBlock_MetaBlockInputReference, getStandardControlBlock_MetaBlockOutputReference, getStandardControlBlock_MetaBlockParameterReference, getStandardControlBlock_MetaBlockStateReference, removeBlockInputReference, removeMetaBlockInputReference, removeMetaBlockOutputReference, removeMetaBlockParameterReference, removeMetaBlockStateReference, removeStandardControlBlock_MetaBlockInputReference, removeStandardControlBlock_MetaBlockOutputReference, removeStandardControlBlock_MetaBlockParameterReference, removeStandardControlBlock_MetaBlockStateReference, setBlockInputReference, setMetaBlockInputReference, setMetaBlockOutputReference, setMetaBlockParameterReference, setMetaBlockStateReference, setStandardControlBlock_MetaBlockInputReference, setStandardControlBlock_MetaBlockOutputReference, setStandardControlBlock_MetaBlockParameterReference, setStandardControlBlock_MetaBlockStateReference

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

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

Class Variables

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

_attrs = ['attributeName']

_defaults = {'attributeName': ''}

_many_refs = []

_refs = []

Inherited from Element'.Element (private): _enums

Properties

Inherited from MetaBlockParameter'.MetaBlockParameter: BlockParameter, MemberOf_MetaBlock

Inherited from MetaBlockConnectable'.MetaBlockConnectable: BlockInputReference, MetaBlockInputReference, MetaBlockOutputReference, MetaBlockParameterReference, MetaBlockStateReference, StandardControlBlock_MetaBlockInputReference, StandardControlBlock_MetaBlockOutputReference, StandardControlBlock_MetaBlockParameterReference, StandardControlBlock_MetaBlockStateReference

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details

init(self, attributeName=`''`, *args, **kw_args)
(Constructor)

Initialises a new 'AttributeBlockParameter' instance.

Parameters:

attributeName - The name of the attribute in the information model. This could be any attribute of the derived class of the power system resource for which the block is intended to be used. For example, if the one were using the xxx attribute from Generator class, one would specifiy this attribute as 'xxx'. This would also limit the block to only those classes which have an 'xxx' attribute. This attribute could be replaced by using the inherited IdentifiedObject.name value for the purpose described above.

Overrides: object.__init__