Class NcActionFrameOutputProbingCycleHelper

Helper methods for ICamApiNcActionProbingCycle and ICamApiFrameOutputProbingCycle.

Inheritance
object
NcActionFrameOutputProbingCycleHelper
Inherited Members
Namespace: CAMAPI.DotnetHelper
Assembly: CAMAPI.DotnetHelper.dll
Syntax
public static class NcActionFrameOutputProbingCycleHelper

Methods

GetFrameOutputFormat(ComWrapper<ICamApiFrameOutputProbingCycle>)

Output format for the frame data: 0 = Matrix, 1 = Quaternion, 2 = EulerXYZ.

Declaration
public static int GetFrameOutputFormat(this ComWrapper<ICamApiFrameOutputProbingCycle> c)
Parameters
Type Name Description
ComWrapper<ICamApiFrameOutputProbingCycle> c
Returns
Type Description
int

GetOutputMode(ComWrapper<ICamApiNcActionProbingCycle>)

Output mode: 0 = EXTCYCLE (output as external cycle call), 1 = INSERT (insert raw NC string directly).

Declaration
public static int GetOutputMode(this ComWrapper<ICamApiNcActionProbingCycle> c)
Parameters
Type Name Description
ComWrapper<ICamApiNcActionProbingCycle> c
Returns
Type Description
int

GetParentFrame(ComWrapper<ICamApiFrameOutputProbingCycle>)

Parent coordinate frame as a 4×4 homogeneous matrix. The target frame is expressed relative to this frame.

Declaration
public static TST3DMatrix GetParentFrame(this ComWrapper<ICamApiFrameOutputProbingCycle> c)
Parameters
Type Name Description
ComWrapper<ICamApiFrameOutputProbingCycle> c
Returns
Type Description
TST3DMatrix

GetStringToInsert(ComWrapper<ICamApiNcActionProbingCycle>)

The NC string to insert when OutputMode is INSERT.

Declaration
public static string GetStringToInsert(this ComWrapper<ICamApiNcActionProbingCycle> c)
Parameters
Type Name Description
ComWrapper<ICamApiNcActionProbingCycle> c
Returns
Type Description
string

GetTargetFrame(ComWrapper<ICamApiFrameOutputProbingCycle>)

Target coordinate frame as a 4×4 homogeneous matrix (position + XYZ Euler rotation in degrees).

Declaration
public static TST3DMatrix GetTargetFrame(this ComWrapper<ICamApiFrameOutputProbingCycle> c)
Parameters
Type Name Description
ComWrapper<ICamApiFrameOutputProbingCycle> c
Returns
Type Description
TST3DMatrix

SetFrameOutputFormat(ComWrapper<ICamApiFrameOutputProbingCycle>, int)

Declaration
public static void SetFrameOutputFormat(this ComWrapper<ICamApiFrameOutputProbingCycle> c, int v)
Parameters
Type Name Description
ComWrapper<ICamApiFrameOutputProbingCycle> c
int v

SetOutputMode(ComWrapper<ICamApiNcActionProbingCycle>, int)

Declaration
public static void SetOutputMode(this ComWrapper<ICamApiNcActionProbingCycle> c, int v)
Parameters
Type Name Description
ComWrapper<ICamApiNcActionProbingCycle> c
int v

SetParentFrame(ComWrapper<ICamApiFrameOutputProbingCycle>, TST3DMatrix)

Declaration
public static void SetParentFrame(this ComWrapper<ICamApiFrameOutputProbingCycle> c, TST3DMatrix v)
Parameters
Type Name Description
ComWrapper<ICamApiFrameOutputProbingCycle> c
TST3DMatrix v

SetStringToInsert(ComWrapper<ICamApiNcActionProbingCycle>, string)

Declaration
public static void SetStringToInsert(this ComWrapper<ICamApiNcActionProbingCycle> c, string v)
Parameters
Type Name Description
ComWrapper<ICamApiNcActionProbingCycle> c
string v

SetTargetFrame(ComWrapper<ICamApiFrameOutputProbingCycle>, TST3DMatrix)

Declaration
public static void SetTargetFrame(this ComWrapper<ICamApiFrameOutputProbingCycle> c, TST3DMatrix v)
Parameters
Type Name Description
ComWrapper<ICamApiFrameOutputProbingCycle> c
TST3DMatrix v