Python scripting OLP - Objects

CENPyOlpAttributeEnum

 

Methods

 

SetOlpProperty(unsigned int iOlpProperty)

 

o

iOlpProperty

OLP attribute use level. Is a bitmask and can be a combination of one ore more levels. (see Attribute use level )

 

Sets Olp Property of attribute.

 

[Example]

myAttrib.SetOlpProperty( USER_ATTRIBUTE | PROCESS_ATTRIBUTE | GLOBAL_ATTRIBUTE )

 


 

GetVisibility(): bool

 

o

return

visibility status from attribute

 

Get visibility status of attribute.

 

[Example]

myAttrib.GetVisibility()

 


 

SetVisibility (visible: bool)

 

o

visible

visibility status to attribute

 

Set visibility status of attribute.

 

[Example]

myAttrib.SetVisibility(True)

 


 

GetName(): string

 

o

return

current name of the attribute

 

Get name of attribute.

 

[Example]

strNyAttribName = myAttrib.GetName()

 


 

SetName(name: string)

 

o

name

new name for the attribute

 

Set name of attribute.

 

[Example]

myAttrib.SetName("NewAttributeName")

 


 

AddLiteral(newLiteral: string)

 

o

newLiteral

The new literal to add

 

Add a new literal to the enum.

 

[Example]

myAttrib.AddLiteral("last") #Adds a new "last" literal to the end of myAttrib literal group. Not undoable!

 


 

SetValue(val: string)

 

o

val

set value for the attribute

 

Set a literal.

 

[Example]

myAttrib.SetValue("last")

 


 

GetValue(): string

 

o

return

value of the attribute

 

Get the literal of enumerator

 

[Example]

enumValue = myAttrib.GetValue()

 


 

GetLiteralIndex(): integer

 

o

return

the index of the current literal within the literal group

 

Get index of literal of SetValue(..).

 

[Example]

current_index = myAttrib.GetLiteralIndex()

 


 

SetReComputeEnterState(reComputeEnterState: ReComputeEnterStates)

 

 

o

reComputeEnterState

Enter state of recompute triggered bu change of this attribute value. (see ReComputeEnterStates )

 

 

[Example]

myAttrib.SetReComputeEnterState( ENTERSTATE_COMPLETE )

 


 

GetReComputeEnterState(): Int

 

o

return

Enter state of recompute triggered bu change of this attribute value. (see ReComputeEnterStates )

 

 

[Example]

reComputeEnterState = myAttrib.GetReComputeEnterState()

 


 


Previous
Page précédente
Chapter
Page principale du chapitre
Next
Page suivante