Event_PE Operator
Quick Facts
| Property | Value |
|---|---|
| Class | CENPyOlpEvent_PEOperator |
| Module | cenpylib.CENPyOlpEvent_PEOperator |
| Package | cenpylib |
| Release | R2025.2.4 |
| Methods | 11 |
| Subclasses | Event_PE Operator Upload |
Inheritance
Quick Start
# Boilerplate Example
# Acquire the event object from the runtime context
event_PEOperator = ... # provided by the frameworkMethod Index
| Method | Returns | Summary |
|---|---|---|
GetAttribGetter | CENPyOlpAttribGetter | Get attribute getter interface. |
GetAttribSetter | CENPyOlpAttribSetter | Get attribute setter interface |
GetLoggerOperator | CENPyOlpLogOperator | Get logger operator. |
GetRefToolpathElementPosition | CENPyOlpMatrix | Determines the base frame position of the reference element of an event. |
GetCurrentToolFrameIndex | int | Get the current tool frame index of the reference TPE. |
GetCurrentBaseFrameIndex | int | Get the current base frame index of the reference TPE. |
GetCurrentToolFrameMatrix | CENPyOlpMatrix | Get the current tool frame matrix of the reference TPE. |
GetCurrentBaseFrameMatrix | CENPyOlpMatrix | Get the current base frame matrix of the reference TPE. |
GetTechTabFolder | int | Gets the technology table folder path. |
IsEventCreatedAutomatically | bool | Get if the reference Event was created by a rule, another event, or inserted manually. |
GetController | CENPyOlpController | Get OLP controller. |
Query Methods
GetAttribGetter
def GetAttribGetter() -> CENPyOlpAttribGetterGet attribute getter interface.
Returns: CENPyOlpAttribGetter — Attribute getter interface.
GetAttribSetter
def GetAttribSetter() -> CENPyOlpAttribSetterGet attribute setter interface
Returns: CENPyOlpAttribSetter — Attribute setter interface
GetLoggerOperator
def GetLoggerOperator() -> CENPyOlpLogOperatorGet logger operator.
Returns: CENPyOlpLogOperator — Logger operator.
GetRefToolpathElementPosition
def GetRefToolpathElementPosition() -> CENPyOlpMatrixDetermines 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() -> intGet the current tool frame index of the reference TPE.
Returns: int — Tool frame index.
GetCurrentBaseFrameIndex
def GetCurrentBaseFrameIndex() -> intGet the current base frame index of the reference TPE.
Returns: int — Base frame index.
GetCurrentToolFrameMatrix
def GetCurrentToolFrameMatrix() -> CENPyOlpMatrixGet the current tool frame matrix of the reference TPE.
Returns: CENPyOlpMatrix — Tool frame matrix.
GetCurrentBaseFrameMatrix
def GetCurrentBaseFrameMatrix() -> CENPyOlpMatrixGet the current base frame matrix of the reference TPE.
Returns: CENPyOlpMatrix — Base frame matrix.
GetTechTabFolder
def GetTechTabFolder() -> intGets 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() -> boolGet 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() -> CENPyOlpControllerGet OLP controller.
Returns: CENPyOlpController — OLP controller.
Related Types
Version Notes
This class is documented as of release R2025.2.4.