Tp Element — Query Methods

`GetName`


def GetName() -> str

Get the name of the toolpath element.

Returns: str — Toolpath element name.

`GetTrack`


def GetTrack() -> CENPyOlpTrack

Get the track corresponding to this toolpath element.

Returns: CENPyOlpTrack — Toolpath track.

`GetProcessType`


def GetProcessType() -> int

Get the process type of the toolpath element.

Returns: int — Process type.

`GetMotionType`


def GetMotionType() -> int

Get the motion type of the toolpath element.

Returns: int — Motion type.

`GetTargetType`


def GetTargetType() -> int

Gets the target type of the underlying toolpath element.

Returns: int — Target type.

`GetConfigBehavior`


def GetConfigBehavior() -> int

Gets the config behavior of the underlying toolpath element.

Returns: int — Target type.

`GetConfigUserString`


def GetConfigUserString() -> str

Gets the config user string of the underlying toolpath element.

Returns: str — Config user string.

`GetTurnBehavior`


def GetTurnBehavior() -> int

Gets the turn behavior of the underlying toolpath element.

Returns: int — Target type.

`GetTurnUserString`


def GetTurnUserString() -> str

Gets the turn user string of the underlying toolpath element.

Returns: str — Turn user string.

`GetCollisionStatus`


def GetCollisionStatus(includeViaPoint: bool=True) -> int

Gets the collision status of the underlying toolpath element. Includes both cost evaluation and simulation results.

Parameters:

Name	Type	Description
`includeViaPoint`	`bool`	If True Via Point result is also included. (default: `True`)

Returns: int — Collision status.

`GetSimulationCollisionStatus`


def GetSimulationCollisionStatus() -> int

Gets the collision status of the underlying toolpath element from the simulation.

Returns: int — Collision status.

`GetReachabilityStatus`


def GetReachabilityStatus() -> int

Gets the reachability status of the underlying toolpath element.

Returns: int — Reachability status

`GetSingularityStatus`


def GetSingularityStatus() -> int

Gets the singularity status of the underlying toolpath element.

Returns: int — Singularity status

`GetTeachFlags`


def GetTeachFlags() -> int

Gets the teach flags indicating the modifications made to the underlying toolpath element.

Returns: int — Teach flags.

`GetMatrix`


def GetMatrix() -> CENPyOlpMatrix

Gets the current matrix of the toolpath element.

Returns: CENPyOlpMatrix — Current matrix.

`GetInitialPathMatrix`


def GetInitialPathMatrix() -> CENPyOlpMatrix

Get the initial path matrix which has been saved after PathCompute but before AlignmentCompute.

Returns: CENPyOlpMatrix — Initial path matrix.

`GetInitialPathMatrixTranslatedInBaseFrame`


def GetInitialPathMatrixTranslatedInBaseFrame(x: float, y: float, z: float, index: int) -> CENPyOlpMatrix

Get the initial path matrix moved with the given coordinates relative to the specified base frame.

Parameters:

Name	Type	Description
`x`	`float`	The translation in X direction.
`y`	`float`	The translation in Y direction.
`z`	`float`	The translation in Z direction.
`index`	`int`	Base frame index.

Returns: CENPyOlpMatrix — Translated initial path matrix.

`GetGlobalTransformedMatrix`


def GetGlobalTransformedMatrix() -> CENPyOlpMatrix

Get the path matrix which has been saved after global transformation compute in aligned state.

Returns: CENPyOlpMatrix — Global transformed path matrix in aligned state.

`GetGlobalTransformedMatrixUnaligned`


def GetGlobalTransformedMatrixUnaligned() -> CENPyOlpMatrix

Get the path matrix which has been saved after global transformation compute in unaligned state.

Returns: CENPyOlpMatrix — Global transformed path matrix in unaligned state.

`GetBaseFrameTransformedMatrixUnaligned`

Since R2025.2.4


def GetBaseFrameTransformedMatrixUnaligned() -> CENPyOlpMatrix

Gets the matrix of the toolpath element on a GlobalTransformed compute state without alignment information with respect to base frame.

Returns: CENPyOlpMatrix — GlobalTransformed compute state matrix - free of alignment.

`GetInitialNeighbourMatrix`


def GetInitialNeighbourMatrix(next: bool=True) -> CENPyOlpMatrix

Get the next or previous toolpath element, relative to the current one, within the current operation. Default is next.

Parameters:

Name	Type	Description
`next`	`bool`	True for the next and False for the previous toolpath element. (default: `True`)

Returns: CENPyOlpMatrix — Matrix of the next or previous toolpath element. None if the start or the end is reached.

`GetMatrixToActiveBaseFrame`


def GetMatrixToActiveBaseFrame() -> CENPyOlpMatrix

Get the toolpath element matrix with respect to active (output) base frame.

Returns: CENPyOlpMatrix — Matrix relative to active (output) base frame.

`GetMatrixToBaseFrame`


def GetMatrixToBaseFrame(index: int) -> CENPyOlpMatrix

Get the toolpath element matrix with respect to the given base frame index.

Parameters:

Name	Type	Description
`index`	`int`	Index of the base frame to which this toolpath matrix should be relative.

Returns: CENPyOlpMatrix — Matrix relative to the given base frame index.

Was this page helpful?