Show / Hide Table of Contents

Interface ICamApiModelFormerWithProbingItems

Interface for model former of probing operations. Allows programmatic manipulation of job assignment items (movements, cycles, groups).

Namespace: CAMAPI.ModelFormerTypes

Assembly: CAMAPI.ModelFormerTypes.dll

Syntax

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("DFFF1A12-5DD9-48FE-A0DB-DC8687827B46")]
public interface ICamApiModelFormerWithProbingItems

Properties

TemplateLibraryCount

Returns the number of loaded template libraries.

Declaration

int TemplateLibraryCount { get; }

Property Value

Type	Description
int

Methods

AddBossCycle()

Add a boss probing cycle (TBossProbingCycle). Returns the typed interface directly.

Declaration

ICamApiBossProbingCycle AddBossCycle()

Returns

Type	Description
ICamApiBossProbingCycle

AddCycleByTemplate(string)

Creates a probing model item from the given template file (TemplateFileName from ICamApiProbingTemplate). Returns the created item, or nil on failure.

Declaration

ICamApiProbingModelItem AddCycleByTemplate(string TemplateFileName)

Parameters

Type	Name	Description
string	TemplateFileName

Returns

Type	Description
ICamApiProbingModelItem

AddDoubleWallExternalCornerCycle()

Add a double-wall external corner probing cycle (TDoubleWallExternalCornerCycle). Returns the typed interface directly.

Declaration

ICamApiDoubleWallExternalCornerCycle AddDoubleWallExternalCornerCycle()

Returns

Type	Description
ICamApiDoubleWallExternalCornerCycle

AddDoubleWallInternalCornerCycle()

Add a double-wall internal corner probing cycle (TDoubleWallInternalCornerCycle). Returns the typed interface directly.

Declaration

ICamApiDoubleWallInternalCornerCycle AddDoubleWallInternalCornerCycle()

Returns

Type	Description
ICamApiDoubleWallInternalCornerCycle

AddExternalRectangleCycle()

Add an external rectangle probing cycle (TExternalRectangleCycle). Returns the typed interface directly.

Declaration

ICamApiExternalRectangleProbingCycle AddExternalRectangleCycle()

Returns

Type	Description
ICamApiExternalRectangleProbingCycle

AddFrameOutputCycle()

Add a frame output probing cycle (TFrameOutputProbingCycle). Returns the typed interface directly.

Declaration

ICamApiFrameOutputProbingCycle AddFrameOutputCycle()

Returns

Type	Description
ICamApiFrameOutputProbingCycle

AddGrooveCycle()

Add a groove probing cycle (TGrooveProbingCycle). Returns the typed interface directly.

Declaration

ICamApiGrooveProbingCycle AddGrooveCycle()

Returns

Type	Description
ICamApiGrooveProbingCycle

AddGrooveProtectedCycle()

Add a groove probing protected cycle (TGrooveProbingCycleProtected). Returns the typed interface directly.

Declaration

ICamApiGrooveProbingProtectedCycle AddGrooveProtectedCycle()

Returns

Type	Description
ICamApiGrooveProbingProtectedCycle

AddGroup()

Add a group item to the job assignment (equivalent to the "Group" button in UI). Returns the created item, or nil on failure.

Declaration

ICamApiProbingModelItem AddGroup()

Returns

Type	Description
ICamApiProbingModelItem

AddHoleCycle()

Add a hole probing cycle (THoleProbingCycle). Returns the typed interface directly.

Declaration

ICamApiHoleProbingCycle AddHoleCycle()

Returns

Type	Description
ICamApiHoleProbingCycle

AddHoleProtectedCycle()

Add a hole probing protected cycle (THoleProbingProtectedCycle). Returns the typed interface directly.

Declaration

ICamApiHoleProbingProtectedCycle AddHoleProtectedCycle()

Returns

Type	Description
ICamApiHoleProbingProtectedCycle

AddInternalRectangleCycle()

Add an internal rectangle probing cycle (TInternalRectangleCycle). Returns the typed interface directly.

Declaration

ICamApiInternalRectangleProbingCycle AddInternalRectangleCycle()

Returns

Type	Description
ICamApiInternalRectangleProbingCycle

AddInternalRectangleProtectedCycle()

Add an internal rectangle probing protected cycle (TInternalRectangleProtectedCycle). Returns the typed interface directly.

Declaration

ICamApiInternalRectangleProbingProtectedCycle AddInternalRectangleProtectedCycle()

Returns

Type	Description
ICamApiInternalRectangleProbingProtectedCycle

AddMovement()

Add a movement item to the job assignment (equivalent to the "Movement" button in UI). Returns the created item, or nil on failure.

Declaration

ICamApiProbingModelItem AddMovement()

Returns

Type	Description
ICamApiProbingModelItem

AddNcActionItem()

Add an NC action probing item (TNCActionProbingItem). Returns the typed interface directly.

Declaration

ICamApiNcActionProbingCycle AddNcActionItem()

Returns

Type	Description
ICamApiNcActionProbingCycle

AddSurfaceCycle()

Add a surface probing cycle (TSingleSurfProbingCycle). Returns the typed interface directly.

Declaration

ICamApiSurfaceProbingCycle AddSurfaceCycle()

Returns

Type	Description
ICamApiSurfaceProbingCycle

AddThreePointsWebCycle()

Add a three-points web probing cycle (TThreePointsWebProbingCycle). Returns the typed interface directly.

Declaration

ICamApiThreePointsWebProbingCycle AddThreePointsWebCycle()

Returns

Type	Description
ICamApiThreePointsWebProbingCycle

AddTripleWallExternalCornerCycle()

Add a triple-wall external corner probing cycle (TTripleWallExternalCornerCycle). Returns the typed interface directly.

Declaration

ICamApiTripleWallExternalCornerCycle AddTripleWallExternalCornerCycle()

Returns

Type	Description
ICamApiTripleWallExternalCornerCycle

AddTripleWallInternalCornerCycle()

Add a triple-wall internal corner probing cycle (TTripleWallInternalCornerCycle). Returns the typed interface directly.

Declaration

ICamApiTripleWallInternalCornerCycle AddTripleWallInternalCornerCycle()

Returns

Type	Description
ICamApiTripleWallInternalCornerCycle

AddWebCycle()

Add a web probing cycle (TWebProbingCycle). Returns the typed interface directly.

Declaration

ICamApiWebProbingCycle AddWebCycle()

Returns

Type	Description
ICamApiWebProbingCycle

Clear()

Removes all items from the probing job assignment tree.

Declaration

void Clear()

DeleteItem(ICamApiProbingModelItem)

Deletes the given item from the probing job assignment tree.

Declaration

void DeleteItem(ICamApiProbingModelItem Item)

Parameters

Type	Name	Description
ICamApiProbingModelItem	Item

GetItems()

Returns a cursor-style iterator starting at the first root-level item. Use with EnumerateProbingItems() helper for LINQ-compatible depth-first traversal.

Declaration

ICamApiProbingModelItemIterator GetItems()

Returns

Type	Description
ICamApiProbingModelItemIterator

GetSelectedItem()

Returns the currently selected item in the job assignment tree, or nil if nothing is selected.

Declaration

ICamApiProbingModelItem GetSelectedItem()

Returns

Type	Description
ICamApiProbingModelItem

GetTemplateLibrary(int)

Declaration

ICamApiProbingTemplateLibrary GetTemplateLibrary(int Index)

Parameters

Type	Name	Description
int	Index

Returns

Type	Description
ICamApiProbingTemplateLibrary