Interface ICamApiApproachReturnCommand

A single command of a custom approach/return rule: a position type plus the axis values that define the intermediate machine position. The set of axes depends on PositionType (3 spatial for GOTO, machine axes for MULTIGOTO/PHYSICGOTO, none for LCS/Stop). Every method reports failures through its out ResultStatus - none raises across the boundary.

Namespace: CAMAPI.TechOperation

Assembly: CAMAPI.TechOperation.dll

Syntax

[Guid("B7E4C1A2-9F3D-4E6A-8C15-2A7F6D9E0B34")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamApiApproachReturnCommand

Methods

GetAxisCount(out TResultStatus)

Declaration

int GetAxisCount(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

Returns

Type	Description
int

GetAxisId(int, out TResultStatus)

Declaration

string GetAxisId(int AxisIndex, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	AxisIndex
TResultStatus	ResultStatus

Returns

Type	Description
string

GetAxisKind(int, out TResultStatus)

Declaration

TCamApiApproachReturnAxisKind GetAxisKind(int AxisIndex, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	AxisIndex
TResultStatus	ResultStatus

Returns

Type	Description
TCamApiApproachReturnAxisKind

GetAxisMode(int, out TResultStatus)

Declaration

TCamApiApproachReturnAxisMode GetAxisMode(int AxisIndex, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	AxisIndex
TResultStatus	ResultStatus

Returns

Type	Description
TCamApiApproachReturnAxisMode

GetAxisValue(int, out TResultStatus)

Declaration

double GetAxisValue(int AxisIndex, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	AxisIndex
TResultStatus	ResultStatus

Returns

Type	Description
double

GetPositionType(out TResultStatus)

Declaration

TCamApiApproachReturnPositionType GetPositionType(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

Returns

Type	Description
TCamApiApproachReturnPositionType

SetAxisAuto(int, out TResultStatus)

Declaration

void SetAxisAuto(int AxisIndex, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	AxisIndex
TResultStatus	ResultStatus

SetAxisUnset(int, out TResultStatus)

Declaration

void SetAxisUnset(int AxisIndex, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	AxisIndex
TResultStatus	ResultStatus

SetAxisValue(int, double, out TResultStatus)

Declaration

void SetAxisValue(int AxisIndex, double Value, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	AxisIndex
double	Value
TResultStatus	ResultStatus

SetPositionType(TCamApiApproachReturnPositionType, out TResultStatus)

Declaration

void SetPositionType(TCamApiApproachReturnPositionType Value, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TCamApiApproachReturnPositionType	Value
TResultStatus	ResultStatus