Python scripting - Objects

CENPyOlpAttributeDouble

 

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 of the 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]

strMyAttribName = myAttrib.GetName()

 


 

SetName(name: string)

 

o

name

new name for the attribute

 

Set name of attribute.

 

[Example]

myAttrib.SetName('NewAttributeName')

 

 


 

SetValue(value: float)

 

o

value

new value for the attribute

 

Set double value of attribute.

 

[Example]

myAttrib.SetValue(22.22)

 


 

GetValue(): float

 

o

return

current value of the attribute

 

Get double value of attribute.

 

[Example]

myAttribVal = myAttrib.GetValue()

 


 

SetMinimum(min: float)

 

o

min

new minimum value for the attribute

 

Set minimal value for the attribute.

 

[Example]

myAttrib.SetMinimum(0.1)

 


 

GetMinimum(): float

 

o

return

current minimum value of the attribute

 

Get minimal value for the attribute.

 

[Example]

myAttribMin = myAttrib.GetMinimum()

 


 

SetMaximum(max: float)

 

o

max

new maximum value for the attribute

 

Set maximal value for the attribute.

 

[Example]

myAttrib.SetMaximum(100)

 


 

GetMaximum(): float

 

o

return

current maximum value of the attribute

 

Get maximal value for the attribute.

 

[Example]

myAttribMax = myAttrib.GetMaximum()

 


 

SetStepSize(step: float)

 

o

value

new step size for the attribute

 

Set step size for the attribute.

 

[Example]

myAttrib.SetStepSize(0.002)

 


 

GetStepSize(): float

 

o

return

current step size of the attribute

 

Get step size for the attribute.

 

[Example]

myAttribStep = myAttrib.GetStepSize()

 


 

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