Event_Event Compute Operator — Query Methods
Back to Event_Event Compute Operator.
GetAttribGetter
def GetAttribGetter() -> CENPyOlpAttribGetterGet attribute getter interface.
Returns: CENPyOlpAttribGetter — Attribute getter interface.
GetLoggerOperator
def GetLoggerOperator() -> CENPyOlpLogOperatorGets logger operator.
Returns: CENPyOlpLogOperator — Logger operator.
GetRefTpElement
def GetRefTpElement() -> CENPyOlpTpElementEach olp event definition is attached to a toolpath element, which is the reference toolpath element.
Returns: CENPyOlpTpElement — Reference toolpath element of the event definition
GetInitialPathMatrixByLength
def GetInitialPathMatrixByLength(length: float) -> CENPyOlpMatrixGets initial path matrix of toolpath element at given length. Remark: When at given length no toolpath element exists, temporary one is created (deleted after usage immediately).
Parameters:
| Name | Type | Description |
|---|---|---|
length | float | length of path where matrix is calculated. |
Returns: CENPyOlpMatrix — Matrix at given length, None if no one could be calculated.
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 parent operation.
Returns: int — Tool frame index.
GetCurrentToolResourceName
def GetCurrentToolResourceName() -> intGet the resource name of the active tool.
Returns: int — Resource name of the active tool.
GetCurrentBaseFrameIndex
def GetCurrentBaseFrameIndex() -> intGet the current base frame index of the parent operation.
Returns: int — Base frame index.
GetCurrentToolFrameMatrix
def GetCurrentToolFrameMatrix() -> CENPyOlpMatrixGet the current tool frame matrix of the parent operation.
Returns: CENPyOlpMatrix — Tool frame matrix.
GetCurrentBaseFrameMatrix
def GetCurrentBaseFrameMatrix() -> CENPyOlpMatrixGet the current base frame matrix of the parent operation.
Returns: CENPyOlpMatrix — Base frame matrix.
GetController
def GetController() -> CENPyOlpControllerGets OLP controller.
Returns: CENPyOlpController — OLP controller.
GetEventOperator
def GetEventOperator() -> CENPyOlpEventOperatorGets the event operator for managing events.
Returns: CENPyOlpEventOperator — Event operator.
GetTouchSensingOperator
def GetTouchSensingOperator() -> CENPyOlpTouchSensingOperatorGets a TouchSensing Operator which contains touch sensing positions.
Returns: CENPyOlpTouchSensingOperator — TouchSensing operator.
GetSeamFindingOperator
def GetSeamFindingOperator() -> CENPyOlpSeamFindingOperatorGets a SeamFinding Operator which contains SeamFinding positions.
Returns: CENPyOlpSeamFindingOperator — SeamFinding operator.
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.
GetTpElementPosition
def GetTpElementPosition(tpElement: CENPyOlpTpElement, posRelation: int) -> CENPyOlpPositionGet the position of the toolpath element.
Parameters:
| Name | Type | Description |
|---|---|---|
tpElement | CENPyOlpTpElement | Reference toolpath element. |
posRelation | int | Relation of the position. |
Returns: CENPyOlpPosition — Toolpath element position.
GetTpElementPosition
def GetTpElementPosition(tpElement: CENPyOlpTpElement, posRelation: int, baseFrameIndex: int) -> CENPyOlpPositionGet the position of the toolpath element relative to the given base frame, specified by its index.
Parameters:
| Name | Type | Description |
|---|---|---|
tpElement | CENPyOlpTpElement | Reference toolpath element. |
posRelation | int | Relation of the position. |
baseFrameIndex | int | Base frame index. |
Returns: CENPyOlpPosition — Toolpath element position.
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.
IsPythonEvent
def IsPythonEvent() -> boolChecks if the reference event is a C++ or python event.
Returns: bool — True if it is a python event, False if not.