Show / Hide Table of Contents

Class TechOperationHelper

Helper methods for ICamApiTechOperation

Inheritance

object

TechOperationHelper

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 TechOperationHelper

Methods

ApproachRule(ComWrapper<ICamApiTechOperation>)

Approach move before operation start

Declaration

public static string ApproachRule(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
string

Calculated(ComWrapper<ICamApiTechOperation>)

The operation toolpath is calculated

Declaration

public static bool Calculated(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

Enabled(ComWrapper<ICamApiTechOperation>)

The operation is blocked for calculation or not

Declaration

public static bool Enabled(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

ExportToolpath(ComWrapper<ICamApiTechOperation>, ICamApiExportToolpathReceiver)

Export toolpath of the operation to any desired format

Declaration

public static void ExportToolpath(this ComWrapper<ICamApiTechOperation> operationCom, ICamApiExportToolpathReceiver toolpathReceiver)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom	Operation COM object
ICamApiExportToolpathReceiver	toolpathReceiver	Receiver that handles the exported toolpath

FullName(ComWrapper<ICamApiTechOperation>)

Slash divided full name of technology operation including parent groups

Declaration

public static string FullName(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
string

GetBlocksStatistics(ComWrapper<ICamApiTechOperation>)

Get block count statistics of the operation toolpath (lines, arcs, multi-gotos, feed blocks). Returns zero values if toolpath is not calculated.

Declaration

public static TCamApiTechOperationBlocksStatistics GetBlocksStatistics(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
TCamApiTechOperationBlocksStatistics

GetFirstChildOperation(ComWrapper<ICamApiTechOperation>, TCamApiReorderingMode)

Get first child operation in the operations tree

Declaration

public static ComWrapper<ICamApiTechOperation> GetFirstChildOperation(this ComWrapper<ICamApiTechOperation> operationCom, TCamApiReorderingMode reorderingMode)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom	Operation COM object
TCamApiReorderingMode	reorderingMode	Mode of the technology operations tree

Returns

Type	Description
ComWrapper<ICamApiTechOperation>

GetLengthStatistics(ComWrapper<ICamApiTechOperation>)

Get length statistics of the operation toolpath (work, rapid, return, and other movement lengths). Returns zero values if toolpath is not calculated.

Declaration

public static TCamApiTechOperationLengthStatistics GetLengthStatistics(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
TCamApiTechOperationLengthStatistics

GetNextSiblingOperation(ComWrapper<ICamApiTechOperation>, TCamApiReorderingMode)

Get next sibling operation in the operations tree

Declaration

public static ComWrapper<ICamApiTechOperation> GetNextSiblingOperation(this ComWrapper<ICamApiTechOperation> operationCom, TCamApiReorderingMode reorderingMode)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom	Operation COM object
TCamApiReorderingMode	reorderingMode	Mode of the technology operations tree

Returns

Type	Description
ComWrapper<ICamApiTechOperation>

GetParentOperation(ComWrapper<ICamApiTechOperation>, TCamApiReorderingMode)

Get parent operation in the operations tree

Declaration

public static ComWrapper<ICamApiTechOperation> GetParentOperation(this ComWrapper<ICamApiTechOperation> operationCom, TCamApiReorderingMode reorderingMode)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom	Operation COM object
TCamApiReorderingMode	reorderingMode	Mode of the technology operations tree

Returns

Type	Description
ComWrapper<ICamApiTechOperation>

GetPropIterator(ComWrapper<ICamApiTechOperation>, string)

Get iterator for all properties of the operation

Declaration

public static ComWrapper<IST_CustomPropIterator> GetPropIterator(this ComWrapper<ICamApiTechOperation> operationCom, string pageId)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom
string	pageId

Returns

Type	Description
ComWrapper<IST_CustomPropIterator>

GetTimeStatistics(ComWrapper<ICamApiTechOperation>)

Get time statistics of the operation toolpath (rapid, idle, work, auxiliary time in seconds). Returns zero values if toolpath is not calculated.

Declaration

public static TCamApiTechOperationTimeStatistics GetTimeStatistics(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
TCamApiTechOperationTimeStatistics

HasToolpath(ComWrapper<ICamApiTechOperation>)

Returns true if the operation has its own calculated toolpath that can be exported. Groups have no toolpath. Returns false if the operation is not calculated.

Declaration

public static bool HasToolpath(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

Id(ComWrapper<ICamApiTechOperation>)

Get unique identifier of technology operation

Declaration

public static string Id(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
string

InitMachineEvaluator(ComWrapper<ICamApiTechOperation>, ComWrapper<ICamApiMachineEvaluator>)

Initialize machine evaluator to the state of this operation

Declaration

public static void InitMachineEvaluator(this ComWrapper<ICamApiTechOperation> operationCom, ComWrapper<ICamApiMachineEvaluator> evaluatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom	Operation COM object
ComWrapper<ICamApiMachineEvaluator>	evaluatorCom	Machine evaluator

IsCollisionError(ComWrapper<ICamApiTechOperation>)

Error - the nodes of the machine are in collision

Declaration

public static bool IsCollisionError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsCompensationError(ComWrapper<ICamApiTechOperation>)

Error - the compensation value is too large

Declaration

public static bool IsCompensationError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsError(ComWrapper<ICamApiTechOperation>)

Error in calculating toolpath or simulation

Declaration

public static bool IsError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsGougeError(ComWrapper<ICamApiTechOperation>)

Error - the part is gouged

Declaration

public static bool IsGougeError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsGroup(ComWrapper<ICamApiTechOperation>)

Returns true if the operation is any kind of groups and can have child operations

Declaration

public static bool IsGroup(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsHolderError(ComWrapper<ICamApiTechOperation>)

Error - the contact with the workpiece is on the holder

Declaration

public static bool IsHolderError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsMachiningResultCalculated(ComWrapper<ICamApiTechOperation>)

The machining result is calculated for this operation

Declaration

public static bool IsMachiningResultCalculated(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsPlungeError(ComWrapper<ICamApiTechOperation>)

Error - the tool is plunged at too large an angle

Declaration

public static bool IsPlungeError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsRapidError(ComWrapper<ICamApiTechOperation>)

Error - the contact with the workpiece is on the rapid feed

Declaration

public static bool IsRapidError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsToolOverloadError(ComWrapper<ICamApiTechOperation>)

Error - the tool is overloaded

Declaration

public static bool IsToolOverloadError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsTravelError(ComWrapper<ICamApiTechOperation>)

Error - the axis is moved out of the limits

Declaration

public static bool IsTravelError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

IsTurnDirectionError(ComWrapper<ICamApiTechOperation>)

Error - the tool turn direction is incorrect

Declaration

public static bool IsTurnDirectionError(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

LCS(ComWrapper<ICamApiTechOperation>)

Local coordinate system for current operation

Declaration

public static TST3DMatrix LCS(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
TST3DMatrix

LoadFromXmlProp(ComWrapper<ICamApiTechOperation>, ComWrapper<IST_XMLPropPointer>)

Update properties from XML (it can be its own XMLProp or XMLProp of another operation)

Declaration

public static void LoadFromXmlProp(this ComWrapper<ICamApiTechOperation> operationCom, ComWrapper<IST_XMLPropPointer> xmlProp)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom
ComWrapper<IST_XMLPropPointer>	xmlProp

Machine(ComWrapper<ICamApiTechOperation>)

Get machine instance

Declaration

public static ComWrapper<ICamApiMachine> Machine(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiMachine>

MachineConfiguration(ComWrapper<ICamApiTechOperation>)

Machine configuration for the operation

Declaration

public static ComWrapper<ICamApiMachineConfiguration> MachineConfiguration(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiMachineConfiguration>

ModelFormerFixtures(ComWrapper<ICamApiTechOperation>)

Object to manage model formers of fixture

Declaration

public static ComWrapper<ICamApiModelFormer> ModelFormerFixtures(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiModelFormer>

ModelFormerJobAssignment(ComWrapper<ICamApiTechOperation>)

Object to manage model formers of job assignment

Declaration

public static ComWrapper<ICamApiModelFormer> ModelFormerJobAssignment(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiModelFormer>

ModelFormerPart(ComWrapper<ICamApiTechOperation>)

Object to manage model formers of part

Declaration

public static ComWrapper<ICamApiModelFormer> ModelFormerPart(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiModelFormer>

ModelFormerRestrictions(ComWrapper<ICamApiTechOperation>)

Object to manage model formers of restrictions

Declaration

public static ComWrapper<ICamApiModelFormer> ModelFormerRestrictions(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiModelFormer>

ModelFormerWorkpiece(ComWrapper<ICamApiTechOperation>)

Object to manage model formers of workpiece

Declaration

public static ComWrapper<ICamApiModelFormer> ModelFormerWorkpiece(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiModelFormer>

Name(ComWrapper<ICamApiTechOperation>)

Get name of technology operation

Declaration

public static string Name(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
string

NeedDeleteChips(ComWrapper<ICamApiTechOperation>)

Whether chips need to be deleted before this operation

Declaration

public static bool NeedDeleteChips(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

OperationTag(ComWrapper<ICamApiTechOperation>)

Invisible textual tag of operation. Empty by default. Can be used by external code for custom purposes.

Declaration

public static string OperationTag(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
string

OperationType(ComWrapper<ICamApiTechOperation>)

Type identifier of the technology operation

Declaration

public static string OperationType(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
string

PartIndex(ComWrapper<ICamApiTechOperation>)

Index of the Part inside Technologist to which this operation relates

Declaration

public static int PartIndex(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
int

ReturnRule(ComWrapper<ICamApiTechOperation>)

Return move after operation end

Declaration

public static string ReturnRule(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
string

SaveToXmlProp(ComWrapper<ICamApiTechOperation>)

Save operation properties to XML structure

Declaration

public static ComWrapper<IST_XMLPropPointer> SaveToXmlProp(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

SetApproachRule(ComWrapper<ICamApiTechOperation>, string)

Set approach move before operation start

Declaration

public static void SetApproachRule(this ComWrapper<ICamApiTechOperation> operationCom, string value)

Parameters

Type

Name

Description

ComWrapper<ICamApiTechOperation>

operationCom

string

value

CLData line with approach move. Available formats:

[AUTO] -> avoid collisions
[FromPrev] -> approach from previous position
[FromRoot] -> approach from root position
[SHORT] -> short approach
[Default] -> default approach
G53 A1(2) A2(3) A3(4) A4(5) A5(6) A6(7) E1(1) -> custom approach by absolute axis positions in machine coordinate system

SetName(ComWrapper<ICamApiTechOperation>, string)

Set name of technology operation

Declaration

public static void SetName(this ComWrapper<ICamApiTechOperation> operationCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom
string	value

SetOperationTag(ComWrapper<ICamApiTechOperation>, string)

Set invisible textual tag of operation

Declaration

public static void SetOperationTag(this ComWrapper<ICamApiTechOperation> operationCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom
string	value

SetReturnRule(ComWrapper<ICamApiTechOperation>, string)

Set return move after operation end

Declaration

public static void SetReturnRule(this ComWrapper<ICamApiTechOperation> operationCom, string value)

Parameters

Type

Name

Description

ComWrapper<ICamApiTechOperation>

operationCom

string

value

CLData line with retract move. Available formats:

[AUTO] -> avoid collisions
[FromPrev] -> retract to root position
[FromRoot] -> retract to safe position
[SHORT] -> short retract
[Default] -> default retract
G53 A1(2) A2(3) A3(4) A4(5) A5(6) A6(7) E1(1) -> custom retract by absolute axis positions in machine coordinate system

SetupStageIndex(ComWrapper<ICamApiTechOperation>)

Index of the Setup stage inside Technologist to which this operation relates

Declaration

public static int SetupStageIndex(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
int

Simulated(ComWrapper<ICamApiTechOperation>)

The operation is simulated

Declaration

public static bool Simulated(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
bool

Technologist(ComWrapper<ICamApiTechOperation>)

Owning Technologist of the operation. You can try to cast it to (ICamApiTechnologist)

Declaration

public static ComWrapper<ICamApiTechOperationOwner> Technologist(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiTechOperationOwner>

ToolEntity(ComWrapper<ICamApiTechOperation>)

Machining tool of the operation. You can cast different interfaces to it depend on exact tool type

Declaration

public static ComWrapper<ICamApiMachiningTool> ToolEntity(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiMachiningTool>

Units(ComWrapper<ICamApiTechOperation>)

Measurements of the operation

Declaration

public static TSTSystemUnits Units(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
TSTSystemUnits

WorkpieceCoordinateSystem(ComWrapper<ICamApiTechOperation>)

Workpiece coordinate system of the operation

Declaration

public static ComWrapper<ICamApiWorkpieceCoordinateSystem> WorkpieceCoordinateSystem(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<ICamApiWorkpieceCoordinateSystem>

XMLProp(ComWrapper<ICamApiTechOperation>)

Value in XML-file, describing operation. Call LoadFromXmlProp to apply changes to the operation

Declaration

public static ComWrapper<IST_XMLPropPointer> XMLProp(this ComWrapper<ICamApiTechOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiTechOperation>	operationCom

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>