Class ModelFormerWithProbingItemsHelper
Helper methods for ICamApiModelFormerWithProbingItems
Inherited Members
Namespace: CAMAPI.DotnetHelper
Assembly: CAMAPI.DotnetHelper.dll
Syntax
public static class ModelFormerWithProbingItemsHelper
Methods
AddBossCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a boss probing cycle to the job assignment. Returns ICamApiBossProbingCycle directly.
Declaration
public static ComWrapper<ICamApiBossProbingCycle> AddBossCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiBossProbingCycle> |
AddCycleByTemplate(ComWrapper<ICamApiModelFormerWithProbingItems>, string)
Creates a probing model item from the given template file name.
Declaration
public static ComWrapper<ICamApiProbingModelItem>? AddCycleByTemplate(this ComWrapper<ICamApiModelFormerWithProbingItems> c, string templateFileName)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c | |
| string | templateFileName |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiProbingModelItem> |
AddDoubleWallExternalCornerCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a double-wall external corner probing cycle to the job assignment. Returns ICamApiDoubleWallExternalCornerCycle directly.
Declaration
public static ComWrapper<ICamApiDoubleWallExternalCornerCycle> AddDoubleWallExternalCornerCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiDoubleWallExternalCornerCycle> |
AddDoubleWallInternalCornerCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a double-wall internal corner probing cycle to the job assignment. Returns ICamApiDoubleWallInternalCornerCycle directly.
Declaration
public static ComWrapper<ICamApiDoubleWallInternalCornerCycle> AddDoubleWallInternalCornerCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiDoubleWallInternalCornerCycle> |
AddExternalRectangleCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add an external rectangle probing cycle to the job assignment. Returns ICamApiExternalRectangleProbingCycle directly.
Declaration
public static ComWrapper<ICamApiExternalRectangleProbingCycle> AddExternalRectangleCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiExternalRectangleProbingCycle> |
AddFrameOutputCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a frame output probing cycle to the job assignment. Returns ICamApiFrameOutputProbingCycle directly.
Declaration
public static ComWrapper<ICamApiFrameOutputProbingCycle> AddFrameOutputCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiFrameOutputProbingCycle> |
AddGrooveCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a groove probing cycle to the job assignment. Returns ICamApiGrooveProbingCycle directly.
Declaration
public static ComWrapper<ICamApiGrooveProbingCycle> AddGrooveCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiGrooveProbingCycle> |
AddGrooveProtectedCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a groove probing protected cycle to the job assignment. Returns ICamApiGrooveProbingProtectedCycle directly.
Declaration
public static ComWrapper<ICamApiGrooveProbingProtectedCycle> AddGrooveProtectedCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiGrooveProbingProtectedCycle> |
AddGroup(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a group item to the probing job assignment. Equivalent to clicking the "Group" button in the UI.
Declaration
public static ComWrapper<ICamApiProbingModelItem> AddGroup(this ComWrapper<ICamApiModelFormerWithProbingItems> modelFormerCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | modelFormerCom |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiProbingModelItem> |
AddHoleCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a hole probing cycle to the job assignment. Returns ICamApiHoleProbingCycle directly.
Declaration
public static ComWrapper<ICamApiHoleProbingCycle> AddHoleCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiHoleProbingCycle> |
AddHoleProtectedCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a hole probing protected cycle to the job assignment. Returns ICamApiHoleProbingProtectedCycle directly.
Declaration
public static ComWrapper<ICamApiHoleProbingProtectedCycle> AddHoleProtectedCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiHoleProbingProtectedCycle> |
AddInternalRectangleCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add an internal rectangle probing cycle to the job assignment. Returns ICamApiInternalRectangleProbingCycle directly.
Declaration
public static ComWrapper<ICamApiInternalRectangleProbingCycle> AddInternalRectangleCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiInternalRectangleProbingCycle> |
AddInternalRectangleProtectedCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add an internal rectangle probing protected cycle to the job assignment. Returns ICamApiInternalRectangleProbingProtectedCycle directly.
Declaration
public static ComWrapper<ICamApiInternalRectangleProbingProtectedCycle> AddInternalRectangleProtectedCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiInternalRectangleProbingProtectedCycle> |
AddMovement(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a movement item to the probing job assignment. Equivalent to clicking the "Movement" button in the UI.
Declaration
public static ComWrapper<ICamApiProbingModelItem> AddMovement(this ComWrapper<ICamApiModelFormerWithProbingItems> modelFormerCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | modelFormerCom |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiProbingModelItem> |
AddNcActionItem(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add an NC action probing item to the job assignment. Returns ICamApiNcActionProbingCycle directly.
Declaration
public static ComWrapper<ICamApiNcActionProbingCycle> AddNcActionItem(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiNcActionProbingCycle> |
AddSurfaceCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a surface probing cycle to the job assignment. Returns ICamApiSurfaceProbingCycle directly.
Declaration
public static ComWrapper<ICamApiSurfaceProbingCycle> AddSurfaceCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiSurfaceProbingCycle> |
AddThreePointsWebCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a three-points web probing cycle to the job assignment. Returns ICamApiThreePointsWebProbingCycle directly.
Declaration
public static ComWrapper<ICamApiThreePointsWebProbingCycle> AddThreePointsWebCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiThreePointsWebProbingCycle> |
AddTripleWallExternalCornerCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a triple-wall external corner probing cycle to the job assignment. Returns ICamApiTripleWallExternalCornerCycle directly.
Declaration
public static ComWrapper<ICamApiTripleWallExternalCornerCycle> AddTripleWallExternalCornerCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiTripleWallExternalCornerCycle> |
AddTripleWallInternalCornerCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a triple-wall internal corner probing cycle to the job assignment. Returns ICamApiTripleWallInternalCornerCycle directly.
Declaration
public static ComWrapper<ICamApiTripleWallInternalCornerCycle> AddTripleWallInternalCornerCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiTripleWallInternalCornerCycle> |
AddWebCycle(ComWrapper<ICamApiModelFormerWithProbingItems>)
Add a web probing cycle to the job assignment. Returns ICamApiWebProbingCycle directly.
Declaration
public static ComWrapper<ICamApiWebProbingCycle> AddWebCycle(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiWebProbingCycle> |
Clear(ComWrapper<ICamApiModelFormerWithProbingItems>)
Removes all items from the probing job assignment tree.
Declaration
public static void Clear(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
DeleteItem(ComWrapper<ICamApiModelFormerWithProbingItems>, ComWrapper<ICamApiProbingModelItem>)
Deletes the given item from the probing job assignment tree.
Declaration
public static void DeleteItem(this ComWrapper<ICamApiModelFormerWithProbingItems> c, ComWrapper<ICamApiProbingModelItem> item)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c | |
| ComWrapper<ICamApiProbingModelItem> | item |
EnumerateProbingItems(ComWrapper<ICamApiModelFormerWithProbingItems>)
Enumerates all probing model items (depth-first).
Declaration
public static IEnumerable<ComWrapper<ICamApiProbingModelItem>> EnumerateProbingItems(this ComWrapper<ICamApiModelFormerWithProbingItems> modelFormerCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | modelFormerCom |
Returns
| Type | Description |
|---|---|
| IEnumerable<ComWrapper<ICamApiProbingModelItem>> |
GetSelectedItem(ComWrapper<ICamApiModelFormerWithProbingItems>)
Returns the currently selected item in the job assignment tree, or null if nothing is selected.
Declaration
public static ComWrapper<ICamApiProbingModelItem>? GetSelectedItem(this ComWrapper<ICamApiModelFormerWithProbingItems> modelFormerCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | modelFormerCom |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiProbingModelItem> |
GetTemplateLibrary(ComWrapper<ICamApiModelFormerWithProbingItems>, int)
Returns the template library at the given zero-based index, or null if out of range.
Declaration
public static ComWrapper<ICamApiProbingTemplateLibrary>? GetTemplateLibrary(this ComWrapper<ICamApiModelFormerWithProbingItems> c, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c | |
| int | index |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiProbingTemplateLibrary> |
GetTemplateLibraryCount(ComWrapper<ICamApiModelFormerWithProbingItems>)
Returns the number of loaded probing template libraries.
Declaration
public static int GetTemplateLibraryCount(this ComWrapper<ICamApiModelFormerWithProbingItems> c)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiModelFormerWithProbingItems> | c |
Returns
| Type | Description |
|---|---|
| int |