Class ProbingActionHelper

Helper methods for probing action interfaces.

Inheritance

object

ProbingActionHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class ProbingActionHelper

Methods

GetActionType(ComWrapper<ICamApiProbingAction>)

Gets the XML type name of this action (e.g. "TSetToolOffsetCycleAction").

Declaration

public static string GetActionType(this ComWrapper<ICamApiProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingAction>	actionCom

Returns

Type	Description
string

GetBooleanValue(ComWrapper<ICamApiCustomProbingAction>)

Gets the boolean value.

Declaration

public static bool GetBooleanValue(this ComWrapper<ICamApiCustomProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom

Returns

Type	Description
bool

GetCSNumber(ComWrapper<ICamApiSetWcsProbingAction>)

Gets the CS number (e.g. 54 for G54).

Declaration

public static double GetCSNumber(this ComWrapper<ICamApiSetWcsProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetWcsProbingAction>	actionCom

Returns

Type	Description
double

GetCaption(ComWrapper<ICamApiCustomProbingAction>)

Gets the display caption (PropCaption field).

Declaration

public static string GetCaption(this ComWrapper<ICamApiCustomProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom

Returns

Type	Description
string

GetCode(ComWrapper<ICamApiCustomProbingAction>)

Gets the postprocessor code (PropCode field).

Declaration

public static int GetCode(this ComWrapper<ICamApiCustomProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom

Returns

Type	Description
int

GetComponentNumber(ComWrapper<ICamApiWriteToReportProbingAction>)

Gets the component number for the report entry.

Declaration

public static int GetComponentNumber(this ComWrapper<ICamApiWriteToReportProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiWriteToReportProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamApiCalibratePartProbeProbingAction>)

Gets the first corrector number.

Declaration

public static int GetCorrector1(this ComWrapper<ICamApiCalibratePartProbeProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibratePartProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamApiCalibrateToolProbeProbingAction>)

Gets the first corrector number.

Declaration

public static int GetCorrector1(this ComWrapper<ICamApiCalibrateToolProbeProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibrateToolProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamApiCheckBrokenToolProbingAction>)

Gets the first corrector number.

Declaration

public static int GetCorrector1(this ComWrapper<ICamApiCheckBrokenToolProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCheckBrokenToolProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamApiSetToolOffsetProbingAction>)

Gets the first corrector number.

Declaration

public static int GetCorrector1(this ComWrapper<ICamApiSetToolOffsetProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetToolOffsetProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamApiCalibratePartProbeProbingAction>)

Gets the second corrector number.

Declaration

public static int GetCorrector2(this ComWrapper<ICamApiCalibratePartProbeProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibratePartProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamApiCalibrateToolProbeProbingAction>)

Gets the second corrector number.

Declaration

public static int GetCorrector2(this ComWrapper<ICamApiCalibrateToolProbeProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibrateToolProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamApiCheckBrokenToolProbingAction>)

Gets the second corrector number.

Declaration

public static int GetCorrector2(this ComWrapper<ICamApiCheckBrokenToolProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCheckBrokenToolProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamApiSetToolOffsetProbingAction>)

Gets the second corrector number.

Declaration

public static int GetCorrector2(this ComWrapper<ICamApiSetToolOffsetProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetToolOffsetProbingAction>	actionCom

Returns

Type	Description
int

GetDoubleValue(ComWrapper<ICamApiCustomProbingAction>)

Gets the double value.

Declaration

public static double GetDoubleValue(this ComWrapper<ICamApiCustomProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom

Returns

Type	Description
double

GetFeatureNumber(ComWrapper<ICamApiWriteToReportProbingAction>)

Gets the feature number for the report entry.

Declaration

public static int GetFeatureNumber(this ComWrapper<ICamApiWriteToReportProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiWriteToReportProbingAction>	actionCom

Returns

Type	Description
int

GetIntegerValue(ComWrapper<ICamApiCustomProbingAction>)

Gets the integer value.

Declaration

public static int GetIntegerValue(this ComWrapper<ICamApiCustomProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom

Returns

Type	Description
int

GetOffsetMode(ComWrapper<ICamApiSetWcsProbingAction>)

Gets the WCS offset mode.

Declaration

public static TProbingWcsOffsetMode GetOffsetMode(this ComWrapper<ICamApiSetWcsProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetWcsProbingAction>	actionCom

Returns

Type	Description
TProbingWcsOffsetMode

GetProbeNumber(ComWrapper<ICamApiCalibratePartProbeProbingAction>)

Gets the probe number.

Declaration

public static int GetProbeNumber(this ComWrapper<ICamApiCalibratePartProbeProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibratePartProbeProbingAction>	actionCom

Returns

Type	Description
int

GetProbeNumber(ComWrapper<ICamApiCalibrateToolProbeProbingAction>)

Gets the probe number.

Declaration

public static int GetProbeNumber(this ComWrapper<ICamApiCalibrateToolProbeProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibrateToolProbeProbingAction>	actionCom

Returns

Type	Description
int

GetPropType(ComWrapper<ICamApiCustomProbingAction>)

Gets the value type.

Declaration

public static TProbingCustomPropType GetPropType(this ComWrapper<ICamApiCustomProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom

Returns

Type	Description
TProbingCustomPropType

GetStringValue(ComWrapper<ICamApiCustomProbingAction>)

Gets the string value.

Declaration

public static string GetStringValue(this ComWrapper<ICamApiCustomProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom

Returns

Type	Description
string

GetToolNumber(ComWrapper<ICamApiCheckBrokenToolProbingAction>)

Gets the tool number.

Declaration

public static int GetToolNumber(this ComWrapper<ICamApiCheckBrokenToolProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCheckBrokenToolProbingAction>	actionCom

Returns

Type	Description
int

GetToolNumber(ComWrapper<ICamApiSetToolOffsetProbingAction>)

Gets the tool number.

Declaration

public static int GetToolNumber(this ComWrapper<ICamApiSetToolOffsetProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetToolOffsetProbingAction>	actionCom

Returns

Type	Description
int

SetBooleanValue(ComWrapper<ICamApiCustomProbingAction>, bool)

Sets the boolean value (also sets PropType to pcptBoolean).

Declaration

public static void SetBooleanValue(this ComWrapper<ICamApiCustomProbingAction> actionCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom
bool	value

SetCSNumber(ComWrapper<ICamApiSetWcsProbingAction>, double)

Sets the CS number.

Declaration

public static void SetCSNumber(this ComWrapper<ICamApiSetWcsProbingAction> actionCom, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetWcsProbingAction>	actionCom
double	value

SetCaption(ComWrapper<ICamApiCustomProbingAction>, string)

Sets the display caption.

Declaration

public static void SetCaption(this ComWrapper<ICamApiCustomProbingAction> actionCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom
string	value

SetCode(ComWrapper<ICamApiCustomProbingAction>, int)

Sets the postprocessor code.

Declaration

public static void SetCode(this ComWrapper<ICamApiCustomProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom
int	value

SetComponentNumber(ComWrapper<ICamApiWriteToReportProbingAction>, int)

Sets the component number (switches to explicit mode).

Declaration

public static void SetComponentNumber(this ComWrapper<ICamApiWriteToReportProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiWriteToReportProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamApiCalibratePartProbeProbingAction>, int)

Sets the first corrector number.

Declaration

public static void SetCorrector1(this ComWrapper<ICamApiCalibratePartProbeProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibratePartProbeProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamApiCalibrateToolProbeProbingAction>, int)

Sets the first corrector number.

Declaration

public static void SetCorrector1(this ComWrapper<ICamApiCalibrateToolProbeProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibrateToolProbeProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamApiCheckBrokenToolProbingAction>, int)

Sets the first corrector number.

Declaration

public static void SetCorrector1(this ComWrapper<ICamApiCheckBrokenToolProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCheckBrokenToolProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamApiSetToolOffsetProbingAction>, int)

Sets the first corrector number.

Declaration

public static void SetCorrector1(this ComWrapper<ICamApiSetToolOffsetProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetToolOffsetProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamApiCalibratePartProbeProbingAction>, int)

Sets the second corrector number.

Declaration

public static void SetCorrector2(this ComWrapper<ICamApiCalibratePartProbeProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibratePartProbeProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamApiCalibrateToolProbeProbingAction>, int)

Sets the second corrector number.

Declaration

public static void SetCorrector2(this ComWrapper<ICamApiCalibrateToolProbeProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibrateToolProbeProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamApiCheckBrokenToolProbingAction>, int)

Sets the second corrector number.

Declaration

public static void SetCorrector2(this ComWrapper<ICamApiCheckBrokenToolProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCheckBrokenToolProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamApiSetToolOffsetProbingAction>, int)

Sets the second corrector number.

Declaration

public static void SetCorrector2(this ComWrapper<ICamApiSetToolOffsetProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetToolOffsetProbingAction>	actionCom
int	value

SetDoubleValue(ComWrapper<ICamApiCustomProbingAction>, double)

Sets the double value (also sets PropType to pcptDouble).

Declaration

public static void SetDoubleValue(this ComWrapper<ICamApiCustomProbingAction> actionCom, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom
double	value

SetFeatureNumber(ComWrapper<ICamApiWriteToReportProbingAction>, int)

Sets the feature number (switches to explicit mode).

Declaration

public static void SetFeatureNumber(this ComWrapper<ICamApiWriteToReportProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiWriteToReportProbingAction>	actionCom
int	value

SetIntegerValue(ComWrapper<ICamApiCustomProbingAction>, int)

Sets the integer value (also sets PropType to pcptInteger).

Declaration

public static void SetIntegerValue(this ComWrapper<ICamApiCustomProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom
int	value

SetOffsetMode(ComWrapper<ICamApiSetWcsProbingAction>, TProbingWcsOffsetMode)

Sets the WCS offset mode.

Declaration

public static void SetOffsetMode(this ComWrapper<ICamApiSetWcsProbingAction> actionCom, TProbingWcsOffsetMode value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetWcsProbingAction>	actionCom
TProbingWcsOffsetMode	value

SetProbeNumber(ComWrapper<ICamApiCalibratePartProbeProbingAction>, int)

Sets the probe number.

Declaration

public static void SetProbeNumber(this ComWrapper<ICamApiCalibratePartProbeProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibratePartProbeProbingAction>	actionCom
int	value

SetProbeNumber(ComWrapper<ICamApiCalibrateToolProbeProbingAction>, int)

Sets the probe number.

Declaration

public static void SetProbeNumber(this ComWrapper<ICamApiCalibrateToolProbeProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCalibrateToolProbeProbingAction>	actionCom
int	value

SetPropType(ComWrapper<ICamApiCustomProbingAction>, TProbingCustomPropType)

Sets the value type.

Declaration

public static void SetPropType(this ComWrapper<ICamApiCustomProbingAction> actionCom, TProbingCustomPropType value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom
TProbingCustomPropType	value

SetStringValue(ComWrapper<ICamApiCustomProbingAction>, string)

Sets the string value (also sets PropType to pcptString).

Declaration

public static void SetStringValue(this ComWrapper<ICamApiCustomProbingAction> actionCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomProbingAction>	actionCom
string	value

SetToolNumber(ComWrapper<ICamApiCheckBrokenToolProbingAction>, int)

Sets the tool number.

Declaration

public static void SetToolNumber(this ComWrapper<ICamApiCheckBrokenToolProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCheckBrokenToolProbingAction>	actionCom
int	value

SetToolNumber(ComWrapper<ICamApiSetToolOffsetProbingAction>, int)

Sets the tool number.

Declaration

public static void SetToolNumber(this ComWrapper<ICamApiSetToolOffsetProbingAction> actionCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSetToolOffsetProbingAction>	actionCom
int	value