Speed Event

Quick Facts

Property	Value
Class	`CENPyOlpSpeedEvent`
Module	`cenpylib.CENPyOlpSpeedEvent`
Package	`cenpylib`
Release	R2025.2.4
Methods	6
Inherits from	`CENPyOlpBuiltInEvent`


# Boilerplate Example
# Acquire the event object from the runtime context
speedEvent = ...  # provided by the framework

Method	Returns	Summary
`GetSpeed`	`float`	Get the speed value.
`SetSpeed`	`—`	Set the speed value.
`GetPathType`	`int`	Get the path type that this event is for.
`SetPathType`	`—`	Set the path type that this event is for.
`GetUnit`	`int`	Get the event units.
`SetUnit`	`—`	Set the event units.


def GetSpeed() -> float

Get the speed value.

Returns: float — Speed value.


def GetPathType() -> int

Get the path type that this event is for.

Returns: int — Path type.


def GetUnit() -> int

Get the event units.

Returns: int — Event units.


def SetSpeed(speed: float)

Set the speed value.

Parameters:

Name	Type	Description
`speed`	`float`	New speed value.


def SetPathType(inPathType: int)

Set the path type that this event is for.

Parameters:

Name	Type	Description
`inPathType`	`int`	New path type.


def SetUnit(inUnit: int)

Set the event units. The units must be in the list of allowed units for the event, otherwise, the method does nothing.

Parameters:

Name	Type	Description
`inUnit`	`int`	New event units.

This class is documented as of release R2025.2.4.

Was this page helpful?