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: CAMIPC.DotnetHelper

Assembly: CAMIPC.DotnetHelper.dll

Syntax

public static class ProbingActionHelper

Methods

AddProp(ComWrapper<ICamIpcCustomPropGroupProbingAction>)

Adds a new custom property to this group and returns it.

Declaration

public static ComWrapper<ICamIpcCustomProbingAction> AddProp(this ComWrapper<ICamIpcCustomPropGroupProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomPropGroupProbingAction>	actionCom

Returns

Type	Description
ComWrapper<ICamIpcCustomProbingAction>

GetActionType(ComWrapper<ICamIpcProbingAction>)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcProbingAction>	actionCom

Returns

Type	Description
string

GetBooleanValue(ComWrapper<ICamIpcCustomProbingAction>)

Gets the boolean value.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom

Returns

Type	Description
bool

GetCSNumber(ComWrapper<ICamIpcSetWcsProbingAction>)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetWcsProbingAction>	actionCom

Returns

Type	Description
double

GetCaption(ComWrapper<ICamIpcCustomProbingAction>)

Gets the display caption.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom

Returns

Type	Description
string

GetCode(ComWrapper<ICamIpcCustomProbingAction>)

Gets the postprocessor code.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom

Returns

Type	Description
int

GetComponentNumber(ComWrapper<ICamIpcWriteToReportProbingAction>)

Gets the component number for the report entry.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcWriteToReportProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamIpcCalibratePartProbeProbingAction>)

Gets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibratePartProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamIpcCalibrateToolProbeProbingAction>)

Gets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibrateToolProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamIpcCheckBrokenToolProbingAction>)

Gets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCheckBrokenToolProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector1(ComWrapper<ICamIpcSetToolOffsetProbingAction>)

Gets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetToolOffsetProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamIpcCalibratePartProbeProbingAction>)

Gets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibratePartProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamIpcCalibrateToolProbeProbingAction>)

Gets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibrateToolProbeProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamIpcCheckBrokenToolProbingAction>)

Gets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCheckBrokenToolProbingAction>	actionCom

Returns

Type	Description
int

GetCorrector2(ComWrapper<ICamIpcSetToolOffsetProbingAction>)

Gets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetToolOffsetProbingAction>	actionCom

Returns

Type	Description
int

GetDoubleValue(ComWrapper<ICamIpcCustomProbingAction>)

Gets the double value.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom

Returns

Type	Description
double

GetFeatureNumber(ComWrapper<ICamIpcWriteToReportProbingAction>)

Gets the feature number for the report entry.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcWriteToReportProbingAction>	actionCom

Returns

Type	Description
int

GetGroupCaption(ComWrapper<ICamIpcCustomPropGroupProbingAction>)

Gets the group caption.

Declaration

public static string GetGroupCaption(this ComWrapper<ICamIpcCustomPropGroupProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomPropGroupProbingAction>	actionCom

Returns

Type	Description
string

GetIntegerValue(ComWrapper<ICamIpcCustomProbingAction>)

Gets the integer value.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom

Returns

Type	Description
int

GetOffsetMode(ComWrapper<ICamIpcSetWcsProbingAction>)

Gets the WCS offset mode.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetWcsProbingAction>	actionCom

Returns

Type	Description
TProbingWcsOffsetMode

GetProbeNumber(ComWrapper<ICamIpcCalibratePartProbeProbingAction>)

Gets the probe number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibratePartProbeProbingAction>	actionCom

Returns

Type	Description
int

GetProbeNumber(ComWrapper<ICamIpcCalibrateToolProbeProbingAction>)

Gets the probe number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibrateToolProbeProbingAction>	actionCom

Returns

Type	Description
int

GetProp(ComWrapper<ICamIpcCustomPropGroupProbingAction>, int)

Returns the custom property at the given zero-based index.

Declaration

public static ComWrapper<ICamIpcCustomProbingAction>? GetProp(this ComWrapper<ICamIpcCustomPropGroupProbingAction> actionCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomPropGroupProbingAction>	actionCom
int	index

Returns

Type	Description
ComWrapper<ICamIpcCustomProbingAction>

GetPropCount(ComWrapper<ICamIpcCustomPropGroupProbingAction>)

Returns the number of custom properties in this group.

Declaration

public static int GetPropCount(this ComWrapper<ICamIpcCustomPropGroupProbingAction> actionCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomPropGroupProbingAction>	actionCom

Returns

Type	Description
int

GetPropType(ComWrapper<ICamIpcCustomProbingAction>)

Gets the value type.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom

Returns

Type	Description
TProbingCustomPropType

GetStringValue(ComWrapper<ICamIpcCustomProbingAction>)

Gets the string value.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom

Returns

Type	Description
string

GetToolNumber(ComWrapper<ICamIpcCheckBrokenToolProbingAction>)

Gets the tool number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCheckBrokenToolProbingAction>	actionCom

Returns

Type	Description
int

GetToolNumber(ComWrapper<ICamIpcSetToolOffsetProbingAction>)

Gets the tool number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetToolOffsetProbingAction>	actionCom

Returns

Type	Description
int

SetBooleanValue(ComWrapper<ICamIpcCustomProbingAction>, bool)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom
bool	value

SetCSNumber(ComWrapper<ICamIpcSetWcsProbingAction>, double)

Sets the CS number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetWcsProbingAction>	actionCom
double	value

SetCaption(ComWrapper<ICamIpcCustomProbingAction>, string)

Sets the display caption.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom
string	value

SetCode(ComWrapper<ICamIpcCustomProbingAction>, int)

Sets the postprocessor code.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom
int	value

SetComponentNumber(ComWrapper<ICamIpcWriteToReportProbingAction>, int)

Sets the component number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcWriteToReportProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamIpcCalibratePartProbeProbingAction>, int)

Sets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibratePartProbeProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamIpcCalibrateToolProbeProbingAction>, int)

Sets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibrateToolProbeProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamIpcCheckBrokenToolProbingAction>, int)

Sets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCheckBrokenToolProbingAction>	actionCom
int	value

SetCorrector1(ComWrapper<ICamIpcSetToolOffsetProbingAction>, int)

Sets the first corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetToolOffsetProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamIpcCalibratePartProbeProbingAction>, int)

Sets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibratePartProbeProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamIpcCalibrateToolProbeProbingAction>, int)

Sets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibrateToolProbeProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamIpcCheckBrokenToolProbingAction>, int)

Sets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCheckBrokenToolProbingAction>	actionCom
int	value

SetCorrector2(ComWrapper<ICamIpcSetToolOffsetProbingAction>, int)

Sets the second corrector number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetToolOffsetProbingAction>	actionCom
int	value

SetDoubleValue(ComWrapper<ICamIpcCustomProbingAction>, double)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom
double	value

SetFeatureNumber(ComWrapper<ICamIpcWriteToReportProbingAction>, int)

Sets the feature number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcWriteToReportProbingAction>	actionCom
int	value

SetGroupCaption(ComWrapper<ICamIpcCustomPropGroupProbingAction>, string)

Sets the group caption.

Declaration

public static void SetGroupCaption(this ComWrapper<ICamIpcCustomPropGroupProbingAction> actionCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomPropGroupProbingAction>	actionCom
string	value

SetIntegerValue(ComWrapper<ICamIpcCustomProbingAction>, int)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom
int	value

SetOffsetMode(ComWrapper<ICamIpcSetWcsProbingAction>, TProbingWcsOffsetMode)

Sets the WCS offset mode.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetWcsProbingAction>	actionCom
TProbingWcsOffsetMode	value

SetProbeNumber(ComWrapper<ICamIpcCalibratePartProbeProbingAction>, int)

Sets the probe number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibratePartProbeProbingAction>	actionCom
int	value

SetProbeNumber(ComWrapper<ICamIpcCalibrateToolProbeProbingAction>, int)

Sets the probe number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCalibrateToolProbeProbingAction>	actionCom
int	value

SetPropType(ComWrapper<ICamIpcCustomProbingAction>, TProbingCustomPropType)

Sets the value type.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom
TProbingCustomPropType	value

SetStringValue(ComWrapper<ICamIpcCustomProbingAction>, string)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCustomProbingAction>	actionCom
string	value

SetToolNumber(ComWrapper<ICamIpcCheckBrokenToolProbingAction>, int)

Sets the tool number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcCheckBrokenToolProbingAction>	actionCom
int	value

SetToolNumber(ComWrapper<ICamIpcSetToolOffsetProbingAction>, int)

Sets the tool number.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcSetToolOffsetProbingAction>	actionCom
int	value