Interface IPockets

Gives access to machining tools.

Namespace: TopSolid.Cam.NC.Kernel.Automating

Assembly: TopSolid.Cam.NC.Kernel.Automating.dll

Syntax

public interface IPockets

Methods

GetTool(ElementId)

Gets tool in given pocket.

Declaration

List<ElementId> GetTool(ElementId inPocketId)

Parameters

Type	Name	Description
ElementId	inPocketId	Pocket identifier.

Returns

Type	Description
List<ElementId>	Tool found or empty.

IsPocket(ElementId)

Tells whether an element is a tool.

Declaration

bool IsPocket(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the element to analyze.

Returns

Type	Description
Boolean	True if the element is a tool.

LoadToolInPocket(DocumentId, ElementId)

Load tool from document inside a pocket.

Declaration

List<ElementId> LoadToolInPocket(DocumentId inToolDocumentId, ElementId inPocketId)

Parameters

Type	Name	Description
DocumentId	inToolDocumentId	The in tool document identifier.
ElementId	inPocketId	Pocket identifier.

Returns

Type	Description
List<ElementId>

SetToolInPocket(ElementId, ElementId)

Set tool in given pocket.

Declaration

void SetToolInPocket(ElementId inToolId, ElementId inPocketId)

Parameters

Type	Name	Description
ElementId	inToolId	Tool identifier. Clear pocket if tool is empty.
ElementId	inPocketId	Pocket identifier.