Python scripting OLP - Objects

CENPyOlpSpeedEvent

Previous  Chapter  Next

 

Methods

 

GetType(): BuiltInEventTypes

 

o

return

the type of the built-in event

[Example]   

   evType = event.GetType()

 


 

GetSpeed(): float

 

o

return

the speed value

 

[Example]

   speed = event.GetSpeed()

 


 

SetSpeed(speed: float)

 

o

speed

the speed value

 

[Example]

   event.SetSpeed(1.5)

 


 

GetPathType(): EventPathType

 

o

return

path type

 

Retrieve the path type that this event is for.

 

[Example]

   pathType = event.GetPathType()

 


 

SetPathType(pathType: EventPathType):

 

o

pathType

path type

 

Set the path type that this event is for.

 

[Example]

   event.SetPathType(EVENTPATHTYPE_POINTTOPOINT)

 


 

GetUnit(): ATTRIBUTE_TYPE

 

o

return

event unit

 

Get the event's unit.

 

[Example]

   unit = event.GetUnit()

 


 

SetUnit(unit: ATTRIBUTE_TYPE)

 

o

unit

path type

 

Set the event's unit. The unit must be in the list of allowed units for the event.

Otherwise, the method does nothing.

 

[Example]

   event.SetUnit(ATTRIB_PERCENT)

 

 


Previous
Previous page
Chapter
Chapter page
Next
Next page