Class ProbingCycleHelper

Helper methods for ICamApiProbingCycle

Inheritance

object

ProbingCycleHelper

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 ProbingCycleHelper

Methods

AddCalibratePartProbeAction(ComWrapper<ICamApiProbingCycle>)

Adds a Calibrate Part Probe action (TCalibratePartProbeCycleAction) to this cycle. Returns ICamApiCalibratePartProbeProbingAction directly.

Declaration

public static ComWrapper<ICamApiCalibratePartProbeProbingAction> AddCalibratePartProbeAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiCalibratePartProbeProbingAction>

AddCalibrateToolProbeAction(ComWrapper<ICamApiProbingCycle>)

Adds a Calibrate Tool Probe action (TCalibrateToolProbeCycleAction) to this cycle. Returns ICamApiCalibrateToolProbeProbingAction directly.

Declaration

public static ComWrapper<ICamApiCalibrateToolProbeProbingAction> AddCalibrateToolProbeAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiCalibrateToolProbeProbingAction>

AddCheckBrokenToolAction(ComWrapper<ICamApiProbingCycle>)

Adds a Check Broken Tool action (TCheckBrokenToolCycleAction) to this cycle. Returns ICamApiCheckBrokenToolProbingAction directly.

Declaration

public static ComWrapper<ICamApiCheckBrokenToolProbingAction> AddCheckBrokenToolAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiCheckBrokenToolProbingAction>

AddCustomPropAction(ComWrapper<ICamApiProbingCycle>)

Adds a standalone Custom Prop action (TProbingCycleCustomProp) to this cycle. Returns ICamApiCustomProbingAction directly.

Declaration

public static ComWrapper<ICamApiCustomProbingAction> AddCustomPropAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiCustomProbingAction>

AddCustomPropGroupAction(ComWrapper<ICamApiProbingCycle>)

Adds a Custom Prop Group action (TProbingCycleCustomPropGroup) to this cycle. Returns ICamApiCustomPropGroupProbingAction directly.

Declaration

public static ComWrapper<ICamApiCustomPropGroupProbingAction> AddCustomPropGroupAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiCustomPropGroupProbingAction>

AddSetToolOffsetAction(ComWrapper<ICamApiProbingCycle>)

Adds a Set Tool Offset action (TSetToolOffsetCycleAction) to this cycle. Returns ICamApiSetToolOffsetProbingAction directly.

Declaration

public static ComWrapper<ICamApiSetToolOffsetProbingAction> AddSetToolOffsetAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiSetToolOffsetProbingAction>

AddSetWcsAction(ComWrapper<ICamApiProbingCycle>)

Adds a Set WCS action (TSetWCSCycleAction) to this cycle. Returns ICamApiSetWcsProbingAction directly.

Declaration

public static ComWrapper<ICamApiSetWcsProbingAction> AddSetWcsAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiSetWcsProbingAction>

AddWriteToReportAction(ComWrapper<ICamApiProbingCycle>)

Adds a Write To Report action (TWriteToReportCycleAction) to this cycle. Returns ICamApiWriteToReportProbingAction directly.

Declaration

public static ComWrapper<ICamApiWriteToReportProbingAction> AddWriteToReportAction(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
ComWrapper<ICamApiWriteToReportProbingAction>

GetAction(ComWrapper<ICamApiProbingCycle>, int)

Returns the action at the given zero-based index, or null if out of range. Use AsInstanceOf<TTarget>() to narrow to a typed interface.

Declaration

public static ComWrapper<ICamApiProbingAction>? GetAction(this ComWrapper<ICamApiProbingCycle> cycleCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom
int	index

Returns

Type	Description
ComWrapper<ICamApiProbingAction>

GetActionsCount(ComWrapper<ICamApiProbingCycle>)

Returns the number of actions in this cycle's CycleActions array.

Declaration

public static int GetActionsCount(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
int

GetCaption(ComWrapper<ICamApiProbingCycle>)

Gets the display name of the cycle.

Declaration

public static string GetCaption(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
string

GetFeed(ComWrapper<ICamApiProbingCycle>)

Gets the feed type during transition.

Declaration

public static TProbingFeed GetFeed(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
TProbingFeed

GetFeedDistance(ComWrapper<ICamApiProbingCycle>)

Gets the feed distance.

Declaration

public static double GetFeedDistance(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
double

GetSubCode(ComWrapper<ICamApiProbingCycle>)

Gets the postprocessor sub-code.

Declaration

public static int GetSubCode(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
int

GetTransition(ComWrapper<ICamApiProbingCycle>)

Gets the transition type.

Declaration

public static TProbingTransition GetTransition(this ComWrapper<ICamApiProbingCycle> cycleCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom

Returns

Type	Description
TProbingTransition

SetCaption(ComWrapper<ICamApiProbingCycle>, string)

Sets the display name of the cycle.

Declaration

public static void SetCaption(this ComWrapper<ICamApiProbingCycle> cycleCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom
string	value

SetFeed(ComWrapper<ICamApiProbingCycle>, TProbingFeed)

Sets the feed type during transition.

Declaration

public static void SetFeed(this ComWrapper<ICamApiProbingCycle> cycleCom, TProbingFeed value)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom
TProbingFeed	value

SetFeedDistance(ComWrapper<ICamApiProbingCycle>, double)

Sets the feed distance.

Declaration

public static void SetFeedDistance(this ComWrapper<ICamApiProbingCycle> cycleCom, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom
double	value

SetSubCode(ComWrapper<ICamApiProbingCycle>, int)

Sets the postprocessor sub-code.

Declaration

public static void SetSubCode(this ComWrapper<ICamApiProbingCycle> cycleCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom
int	value

SetTransition(ComWrapper<ICamApiProbingCycle>, TProbingTransition)

Sets the transition type.

Declaration

public static void SetTransition(this ComWrapper<ICamApiProbingCycle> cycleCom, TProbingTransition value)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingCycle>	cycleCom
TProbingTransition	value