Class MachiningToolInfoHelper

Helper methods for ICamApiMachiningToolInfo

Inheritance

object

MachiningToolInfoHelper

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 MachiningToolInfoHelper

Methods

ConnectorID(ComWrapper<ICamApiMachiningToolInfo>)

Text identifier of the machine connector that contains the tool

Declaration

public static string ConnectorID(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
string

FirstCorrectorNumber(ComWrapper<ICamApiMachiningToolInfo>)

The number of first tooling point inside correctors table of CNC controller

Declaration

public static int FirstCorrectorNumber(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
int

MagazineNumber(ComWrapper<ICamApiMachiningToolInfo>)

Number of magazine that contains the tool

Declaration

public static int MagazineNumber(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
int

SetConnectorID(ComWrapper<ICamApiMachiningToolInfo>, string)

Set connector ID for the tool

Declaration

public static void SetConnectorID(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom, string connectorId)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom
string	connectorId

ToolCaption(ComWrapper<ICamApiMachiningToolInfo>)

User friendly tool caption

Declaration

public static string ToolCaption(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
string

ToolEntity(ComWrapper<ICamApiMachiningToolInfo>)

Machining tool itself. You can cast different interfaces to it depending on exact tool type.

Declaration

public static ComWrapper<ICamApiMachiningTool> ToolEntity(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
ComWrapper<ICamApiMachiningTool>

ToolGUID(ComWrapper<ICamApiMachiningToolInfo>)

Global unique identifier of the tool

Declaration

public static string ToolGUID(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
string

ToolID(ComWrapper<ICamApiMachiningToolInfo>)

Identifier of the tool unique in the list of tools

Declaration

public static string ToolID(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
string

ToolNumber(ComWrapper<ICamApiMachiningToolInfo>)

Tool number that identifies the tool inside the CNC controller

Declaration

public static int ToolNumber(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
int

ToolProperties(ComWrapper<ICamApiMachiningToolInfo>)

Properties of the tool. Set of properties depends on tool type.

Declaration

public static ComWrapper<IST_XMLPropPointer> ToolProperties(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

ToolType(ComWrapper<ICamApiMachiningToolInfo>)

The type of the tool in terms of CAM system

Declaration

public static string ToolType(this ComWrapper<ICamApiMachiningToolInfo> toolInfoCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachiningToolInfo>	toolInfoCom

Returns

Type	Description
string