Class ProbingTemplateHelper

Helper methods for ICamApiProbingTemplate and ICamApiProbingTemplateLibrary.

Inheritance

object

ProbingTemplateHelper

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 ProbingTemplateHelper

Methods

GetCaption(ComWrapper<ICamApiProbingTemplateLibrary>)

Gets the display caption of the library.

Declaration

public static string GetCaption(this ComWrapper<ICamApiProbingTemplateLibrary> libCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingTemplateLibrary>	libCom

Returns

Type	Description
string

GetCaption(ComWrapper<ICamApiProbingTemplate>)

Gets the display caption of the template.

Declaration

public static string GetCaption(this ComWrapper<ICamApiProbingTemplate> templateCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingTemplate>	templateCom

Returns

Type	Description
string

GetTemplate(ComWrapper<ICamApiProbingTemplateLibrary>, int)

Returns the template at the given zero-based flat index, or null if out of range.

Declaration

public static ComWrapper<ICamApiProbingTemplate>? GetTemplate(this ComWrapper<ICamApiProbingTemplateLibrary> libCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingTemplateLibrary>	libCom
int	index

Returns

Type	Description
ComWrapper<ICamApiProbingTemplate>

GetTemplateCount(ComWrapper<ICamApiProbingTemplateLibrary>)

Gets the total number of templates in the library (all groups included).

Declaration

public static int GetTemplateCount(this ComWrapper<ICamApiProbingTemplateLibrary> libCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingTemplateLibrary>	libCom

Returns

Type	Description
int

GetTemplateFileName(ComWrapper<ICamApiProbingTemplate>)

Gets the internal template XML file path (used for AddCycleByTemplate).

Declaration

public static string GetTemplateFileName(this ComWrapper<ICamApiProbingTemplate> templateCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProbingTemplate>	templateCom

Returns

Type	Description
string