Class SimulatorHelper

Helper methods for ICamApiSimulator

Inheritance

object

SimulatorHelper

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 SimulatorHelper

Methods

BreakOnEndOfOperation(ComWrapper<ICamApiSimulator>)

Should simulator break simulation on the end of operation

Declaration

public static bool BreakOnEndOfOperation(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

Returns

Type	Description
bool

BreakOnErrors(ComWrapper<ICamApiSimulator>)

Should simulator break simulation on errors

Declaration

public static bool BreakOnErrors(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

Returns

Type	Description
bool

BreakOnStopCommand(ComWrapper<ICamApiSimulator>)

Should simulator break simulation on special STOP command

Declaration

public static bool BreakOnStopCommand(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

Returns

Type	Description
bool

CheckGouges(ComWrapper<ICamApiSimulator>)

Should simulator check for gouges

Declaration

public static bool CheckGouges(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

Returns

Type	Description
bool

CheckHolderCollisions(ComWrapper<ICamApiSimulator>)

Should simulator check for holder collisions

Declaration

public static bool CheckHolderCollisions(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

Returns

Type	Description
bool

CheckMachineCollisions(ComWrapper<ICamApiSimulator>)

Should simulator check for machine collisions

Declaration

public static bool CheckMachineCollisions(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

Returns

Type	Description
bool

FastSimulateAllOperations(ComWrapper<ICamApiSimulator>)

Calculate simulation results for all operations in the project

Declaration

public static void FastSimulateAllOperations(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

FastSimulateCurrentOperation(ComWrapper<ICamApiSimulator>)

Calculate simulation results for the current operation

Declaration

public static void FastSimulateCurrentOperation(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

FastSimulateUpToCurrentOperation(ComWrapper<ICamApiSimulator>)

Calculate simulation results from the first operation to the current operation (inclusive)

Declaration

public static void FastSimulateUpToCurrentOperation(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

ResetSimulationResults(ComWrapper<ICamApiSimulator>)

Stop current simulation and delete all simulation results

Declaration

public static void ResetSimulationResults(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

SaveMachiningResultToSTL(ComWrapper<ICamApiSimulator>, ComWrapper<ICamApiPartStage>?, string)

Save result of simulation to the STL file

Declaration

public static void SaveMachiningResultToSTL(this ComWrapper<ICamApiSimulator> simulatorCom, ComWrapper<ICamApiPartStage>? partStage, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom	Simulator
ComWrapper<ICamApiPartStage>	partStage	Part stage (not used currently)
string	fileName	Full path to result STL file. Will be overwritten if exists

SetBreakOnEndOfOperation(ComWrapper<ICamApiSimulator>, bool)

Should simulator break simulation on the end of operation

Declaration

public static void SetBreakOnEndOfOperation(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom
bool	value

SetBreakOnErrors(ComWrapper<ICamApiSimulator>, bool)

Should simulator break simulation on errors

Declaration

public static void SetBreakOnErrors(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom
bool	value

SetBreakOnStopCommand(ComWrapper<ICamApiSimulator>, bool)

Should simulator break simulation on special STOP command

Declaration

public static void SetBreakOnStopCommand(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom
bool	value

SetCheckGouges(ComWrapper<ICamApiSimulator>, bool)

Should simulator check for gouges

Declaration

public static void SetCheckGouges(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom
bool	value

SetCheckHolderCollisions(ComWrapper<ICamApiSimulator>, bool)

Should simulator check for holder collisions

Declaration

public static void SetCheckHolderCollisions(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom
bool	value

SetCheckMachineCollisions(ComWrapper<ICamApiSimulator>, bool)

Should simulator check for machine collisions

Declaration

public static void SetCheckMachineCollisions(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom
bool	value

SmoothSimulationStart(ComWrapper<ICamApiSimulator>)

Smoothly start simulation from the current operation up to the end

Declaration

public static void SmoothSimulationStart(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

SmoothSimulationStepBackward(ComWrapper<ICamApiSimulator>)

Execute previous command in smooth simulation mode

Declaration

public static void SmoothSimulationStepBackward(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

SmoothSimulationStepForward(ComWrapper<ICamApiSimulator>)

Execute next command in smooth simulation mode

Declaration

public static void SmoothSimulationStepForward(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom

SmoothSimulationStop(ComWrapper<ICamApiSimulator>)

Stop current process of smooth simulation

Declaration

public static void SmoothSimulationStop(this ComWrapper<ICamApiSimulator> simulatorCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiSimulator>	simulatorCom