Interface ICamApiProbingCycle

Typed access to common probing cycle properties. Available only on items whose XML type inherits from TProbingCycle. Use QueryInterface / AsInstanceOf to obtain this interface from ICamApiProbingModelItem.

Namespace: CAMAPI.ModelFormerTypes
Assembly: CAMAPI.ModelFormerTypes.dll
Syntax
[Guid("D5720894-69A3-4D41-9312-9C578B6E32D2")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamApiProbingCycle

Properties

ActionsCount

Number of actions attached to this cycle (elements in the CycleActions array).

Declaration
int ActionsCount { get; }
Property Value
Type Description
int

Caption

Display name of the cycle

Declaration
string Caption { get; set; }
Property Value
Type Description
string

Feed

Feed type during transition

Declaration
TProbingFeed Feed { get; set; }
Property Value
Type Description
TProbingFeed

FeedDistance

Feed distance

Declaration
double FeedDistance { get; set; }
Property Value
Type Description
double

SubCode

Postprocessor sub-code

Declaration
int SubCode { get; set; }
Property Value
Type Description
int

Transition

Transition type to this cycle

Declaration
TProbingTransition Transition { get; set; }
Property Value
Type Description
TProbingTransition

Methods

AddCalibratePartProbeAction()

Add a Calibrate Part Probe action (TCalibratePartProbeCycleAction) to this cycle's action list. Returns the typed interface directly.

Declaration
ICamApiCalibratePartProbeProbingAction AddCalibratePartProbeAction()
Returns
Type Description
ICamApiCalibratePartProbeProbingAction

AddCalibrateToolProbeAction()

Add a Calibrate Tool Probe action (TCalibrateToolProbeCycleAction) to this cycle's action list. Returns the typed interface directly.

Declaration
ICamApiCalibrateToolProbeProbingAction AddCalibrateToolProbeAction()
Returns
Type Description
ICamApiCalibrateToolProbeProbingAction

AddCheckBrokenToolAction()

Add a Check Broken Tool action (TCheckBrokenToolCycleAction) to this cycle's action list. Returns the typed interface directly.

Declaration
ICamApiCheckBrokenToolProbingAction AddCheckBrokenToolAction()
Returns
Type Description
ICamApiCheckBrokenToolProbingAction

AddCustomPropAction()

Add a standalone Custom Prop action (TProbingCycleCustomProp) to this cycle's action list. Returns the typed interface directly.

Declaration
ICamApiCustomProbingAction AddCustomPropAction()
Returns
Type Description
ICamApiCustomProbingAction

AddCustomPropGroupAction()

Add a Custom Prop Group action (TProbingCycleCustomPropGroup) to this cycle's action list. Returns the typed interface directly; call AddProp() on it to add custom properties.

Declaration
ICamApiCustomPropGroupProbingAction AddCustomPropGroupAction()
Returns
Type Description
ICamApiCustomPropGroupProbingAction

AddSetToolOffsetAction()

Add a Set Tool Offset action (TSetToolOffsetCycleAction) to this cycle's action list. Returns the typed interface directly.

Declaration
ICamApiSetToolOffsetProbingAction AddSetToolOffsetAction()
Returns
Type Description
ICamApiSetToolOffsetProbingAction

AddSetWcsAction()

Add a Set WCS action (TSetWCSCycleAction) to this cycle's action list. Returns the typed interface directly.

Declaration
ICamApiSetWcsProbingAction AddSetWcsAction()
Returns
Type Description
ICamApiSetWcsProbingAction

AddWriteToReportAction()

Add a Write To Report action (TWriteToReportCycleAction) to this cycle's action list. Returns the typed interface directly.

Declaration
ICamApiWriteToReportProbingAction AddWriteToReportAction()
Returns
Type Description
ICamApiWriteToReportProbingAction

GetAction(int)

Declaration
ICamApiProbingAction GetAction(int ItemIndex)
Parameters
Type Name Description
int ItemIndex
Returns
Type Description
ICamApiProbingAction