Skip to Content

Event_PE Operator

Quick Facts

PropertyValue
ClassCENPyOlpEvent_PEOperator
Modulecenpylib.CENPyOlpEvent_PEOperator
Packagecenpylib
ReleaseR2025.2.4
Methods11
SubclassesEvent_PE Operator Upload

Inheritance

Quick Start

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

Method Index

MethodReturnsSummary
GetAttribGetterCENPyOlpAttribGetterGet attribute getter interface.
GetAttribSetterCENPyOlpAttribSetterGet attribute setter interface
GetLoggerOperatorCENPyOlpLogOperatorGet logger operator.
GetRefToolpathElementPositionCENPyOlpMatrixDetermines the base frame position of the reference element of an event.
GetCurrentToolFrameIndexintGet the current tool frame index of the reference TPE.
GetCurrentBaseFrameIndexintGet the current base frame index of the reference TPE.
GetCurrentToolFrameMatrixCENPyOlpMatrixGet the current tool frame matrix of the reference TPE.
GetCurrentBaseFrameMatrixCENPyOlpMatrixGet the current base frame matrix of the reference TPE.
GetTechTabFolderintGets the technology table folder path.
IsEventCreatedAutomaticallyboolGet if the reference Event was created by a rule, another event, or inserted manually.
GetControllerCENPyOlpControllerGet OLP controller.

Query Methods

GetAttribGetter

def GetAttribGetter() -> CENPyOlpAttribGetter

Get attribute getter interface.

Returns: CENPyOlpAttribGetter — Attribute getter interface.

GetAttribSetter

def GetAttribSetter() -> CENPyOlpAttribSetter

Get attribute setter interface

Returns: CENPyOlpAttribSetter — Attribute setter interface

GetLoggerOperator

def GetLoggerOperator() -> CENPyOlpLogOperator

Get logger operator.

Returns: CENPyOlpLogOperator — Logger operator.

GetRefToolpathElementPosition

def GetRefToolpathElementPosition() -> CENPyOlpMatrix

Determines the base frame position of the reference element of an event. Be aware: This will return nullptr if it is not called on an OlpEventDefinition.

Returns: CENPyOlpMatrix — Nullptr or the base frame position of the reference toolpath element.

GetCurrentToolFrameIndex

def GetCurrentToolFrameIndex() -> int

Get the current tool frame index of the reference TPE.

Returns: int — Tool frame index.

GetCurrentBaseFrameIndex

def GetCurrentBaseFrameIndex() -> int

Get the current base frame index of the reference TPE.

Returns: int — Base frame index.

GetCurrentToolFrameMatrix

def GetCurrentToolFrameMatrix() -> CENPyOlpMatrix

Get the current tool frame matrix of the reference TPE.

Returns: CENPyOlpMatrix — Tool frame matrix.

GetCurrentBaseFrameMatrix

def GetCurrentBaseFrameMatrix() -> CENPyOlpMatrix

Get the current base frame matrix of the reference TPE.

Returns: CENPyOlpMatrix — Base frame matrix.

GetTechTabFolder

def GetTechTabFolder() -> int

Gets the technology table folder path. If the relative path contains a file name with extension then it will return the path to that file.

Returns: int — Technology table folder or a file path.

IsEventCreatedAutomatically

def IsEventCreatedAutomatically() -> bool

Get if the reference Event was created by a rule, another event, or inserted manually.

Returns: bool — True if the Event was created by a rule or by another Event, False if inserted manually.

GetController

def GetController() -> CENPyOlpController

Get OLP controller.

Returns: CENPyOlpController — OLP controller.

Version Notes

This class is documented as of release R2025.2.4.

Was this page helpful?