Acceleration Event

Quick Facts

Property	Value
Class	`CENPyOlpAccelerationEvent`
Module	`cenpylib.CENPyOlpAccelerationEvent`
Package	`cenpylib`
Release	R2025.2.4
Methods	5
Inherits from	`CENPyOlpBuiltInEvent`


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

Method	Returns	Summary
`GetAcceleration`	`float`	Get the acceleration value.
`SetAcceleration`	`—`	Sets the acceleration value.
`SetUnit`	`—`	Set the event’s unit.
`GetPathType`	`int`	Retrieve the path type that this event is associated with.
`SetPathType`	`—`	Set the path type that this event will be associated with.


def GetAcceleration() -> float

Get the acceleration value.

Returns: float — acceleration value.


def GetPathType() -> int

Retrieve the path type that this event is associated with.

Returns: int — event path type


def SetAcceleration(acceleration: float)

Sets the acceleration value.

Parameters:

Name	Type	Description
`acceleration`	`float`	the acceleration value


def SetUnit(inUnit: int)

Set the event’s unit. The unit must be in the list of allowed units for the event. Otherwise, the method does nothing.

Parameters:

Name	Type	Description
`inUnit`	`int`	event’s unit


def SetPathType(inPathType: int)

Set the path type that this event will be associated with.

Parameters:

Name	Type	Description
`inPathType`	`int`	path type

This class is documented as of release R2025.2.4.

Was this page helpful?