Class SimulatorHelper
Inheritance
SimulatorHelper
Assembly: CAMIPC.DotnetHelper.dll
Syntax
public static class SimulatorHelper
Methods
BreakOnEndOfOperation(ComWrapper<ICamIpcSimulator>)
Should simulator break simulation on the end of operation
Declaration
public static bool BreakOnEndOfOperation(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
BreakOnErrors(ComWrapper<ICamIpcSimulator>)
Should simulator break simulation on errors
Declaration
public static bool BreakOnErrors(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
BreakOnStopCommand(ComWrapper<ICamIpcSimulator>)
Should simulator break simulation on special STOP command
Declaration
public static bool BreakOnStopCommand(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
Channel(ComWrapper<ICamIpcSimulator>, int)
Channel by zero-based index in range [0..ChannelCount-1].
Declaration
public static ComWrapper<ICamIpcMcdChannel> Channel(this ComWrapper<ICamIpcSimulator> simulatorCom, int index)
Parameters
Returns
ChannelCount(ComWrapper<ICamIpcSimulator>)
Number of execution channels in the simulator (always at least 1).
Declaration
public static int ChannelCount(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
CheckGouges(ComWrapper<ICamIpcSimulator>)
Should simulator check for gouges
Declaration
public static bool CheckGouges(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
CheckHiddenNodesCollisions(ComWrapper<ICamIpcSimulator>)
Should simulator check for collisions with hidden machine nodes (deepest detection level).
Setting this to true also enables CheckMachineCollisions and CheckHolderCollisions.
Declaration
public static bool CheckHiddenNodesCollisions(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
CheckHolderCollisions(ComWrapper<ICamIpcSimulator>)
Should simulator check for holder collisions.
Setting this to false also disables CheckMachineCollisions and CheckHiddenNodesCollisions.
Declaration
public static bool CheckHolderCollisions(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
CheckMachineCollisions(ComWrapper<ICamIpcSimulator>)
Should simulator check for machine collisions.
Setting this to true also enables CheckHolderCollisions.
Setting this to false also disables CheckHiddenNodesCollisions.
Declaration
public static bool CheckMachineCollisions(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
CompensationCurveVisible(ComWrapper<ICamIpcSimulator>)
Whether tool compensation curve is shown in the simulation viewport
Declaration
public static bool CompensationCurveVisible(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
FastSimulateAllOperations(ComWrapper<ICamIpcSimulator>)
Calculate simulation results for all operations in the project
Declaration
public static void FastSimulateAllOperations(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
FastSimulateCurrentOperation(ComWrapper<ICamIpcSimulator>)
Calculate simulation results for the current operation
Declaration
public static void FastSimulateCurrentOperation(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
FastSimulateUpToCurrentOperation(ComWrapper<ICamIpcSimulator>)
Calculate simulation results from the first operation to the current operation (inclusive)
Declaration
public static void FastSimulateUpToCurrentOperation(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
GoToNextError(ComWrapper<ICamIpcSimulator>)
Activate the next simulation error: the next CLDATA command with an error,
or the next operation that has errors. If no further error exists, the active node is unchanged.
Declaration
public static void GoToNextError(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
GoToPrevError(ComWrapper<ICamIpcSimulator>)
Activate the previous simulation error: the previous CLDATA command with an error,
or the previous operation that has errors. If no prior error exists, the active node is unchanged.
Declaration
public static void GoToPrevError(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
MultiChannelMode(ComWrapper<ICamIpcSimulator>)
Whether the multi-channel simulation mode is enabled.
Declaration
public static bool MultiChannelMode(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
RapidScalePower(ComWrapper<ICamIpcSimulator>)
Rapid motion scale as a power of 2: 0 = x1, 1 = x2, ..., 7 = x128
Declaration
public static int RapidScalePower(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
ResetSimulationResults(ComWrapper<ICamIpcSimulator>)
Stop current simulation and delete all simulation results
Declaration
public static void ResetSimulationResults(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
SaveMachiningResultToSTL(ComWrapper<ICamIpcSimulator>, ComWrapper<ICamIpcPartStage>?, string)
Save result of simulation to the STL file
Declaration
public static void SaveMachiningResultToSTL(this ComWrapper<ICamIpcSimulator> simulatorCom, ComWrapper<ICamIpcPartStage>? partStage, string fileName)
Parameters
SetBreakOnEndOfOperation(ComWrapper<ICamIpcSimulator>, bool)
Should simulator break simulation on the end of operation
Declaration
public static void SetBreakOnEndOfOperation(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetBreakOnErrors(ComWrapper<ICamIpcSimulator>, bool)
Should simulator break simulation on errors
Declaration
public static void SetBreakOnErrors(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetBreakOnStopCommand(ComWrapper<ICamIpcSimulator>, bool)
Should simulator break simulation on special STOP command
Declaration
public static void SetBreakOnStopCommand(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetCheckGouges(ComWrapper<ICamIpcSimulator>, bool)
Should simulator check for gouges
Declaration
public static void SetCheckGouges(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetCheckHiddenNodesCollisions(ComWrapper<ICamIpcSimulator>, bool)
Should simulator check for collisions with hidden machine nodes (deepest detection level).
Setting this to true also enables CheckMachineCollisions and CheckHolderCollisions.
Declaration
public static void SetCheckHiddenNodesCollisions(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetCheckHolderCollisions(ComWrapper<ICamIpcSimulator>, bool)
Should simulator check for holder collisions.
Setting this to false also disables CheckMachineCollisions and CheckHiddenNodesCollisions.
Declaration
public static void SetCheckHolderCollisions(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetCheckMachineCollisions(ComWrapper<ICamIpcSimulator>, bool)
Should simulator check for machine collisions.
Setting this to true also enables CheckHolderCollisions.
Setting this to false also disables CheckHiddenNodesCollisions.
Declaration
public static void SetCheckMachineCollisions(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetCompensationCurveVisible(ComWrapper<ICamIpcSimulator>, bool)
Whether tool compensation curve is shown in the simulation viewport
Declaration
public static void SetCompensationCurveVisible(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetMultiChannelMode(ComWrapper<ICamIpcSimulator>, bool)
Set whether the multi-channel simulation mode is enabled.
Declaration
public static void SetMultiChannelMode(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SetRapidScalePower(ComWrapper<ICamIpcSimulator>, int)
Rapid motion scale as a power of 2: 0 = x1, 1 = x2, ..., 7 = x128
Declaration
public static void SetRapidScalePower(this ComWrapper<ICamIpcSimulator> simulatorCom, int value)
Parameters
SetSimulationMethod(ComWrapper<ICamIpcSimulator>, TCamIpcSimulationMethod)
Simulation method (solid / voxel 3D / voxel 5D)
Declaration
public static void SetSimulationMethod(this ComWrapper<ICamIpcSimulator> simulatorCom, TCamIpcSimulationMethod value)
Parameters
SetSimulationSpeedPercent(ComWrapper<ICamIpcSimulator>, int)
Speed of smooth simulation in percents (0-100)
Declaration
public static void SetSimulationSpeedPercent(this ComWrapper<ICamIpcSimulator> simulatorCom, int value)
Parameters
SetSmoothSimulationEnabled(ComWrapper<ICamIpcSimulator>, bool)
Smooth simulation mode: when true, toolpath is painted continuously along the trajectory;
when false, simulation advances per block
Declaration
public static void SetSmoothSimulationEnabled(this ComWrapper<ICamIpcSimulator> simulatorCom, bool value)
Parameters
SimulationMethod(ComWrapper<ICamIpcSimulator>)
Simulation method (solid / voxel 3D / voxel 5D)
Declaration
public static TCamIpcSimulationMethod SimulationMethod(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
SimulationSpeedPercent(ComWrapper<ICamIpcSimulator>)
Speed of smooth simulation in percents (0-100)
Declaration
public static int SimulationSpeedPercent(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
SmoothSimulationEnabled(ComWrapper<ICamIpcSimulator>)
Smooth simulation mode: when true, toolpath is painted continuously along the trajectory;
when false, simulation advances per block
Declaration
public static bool SmoothSimulationEnabled(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
Returns
SmoothSimulationStart(ComWrapper<ICamIpcSimulator>)
Smoothly start simulation from the current operation up to the end
Declaration
public static void SmoothSimulationStart(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
SmoothSimulationStepBackward(ComWrapper<ICamIpcSimulator>)
Execute previous command in smooth simulation mode
Declaration
public static void SmoothSimulationStepBackward(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
SmoothSimulationStepForward(ComWrapper<ICamIpcSimulator>)
Execute next command in smooth simulation mode
Declaration
public static void SmoothSimulationStepForward(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters
SmoothSimulationStop(ComWrapper<ICamIpcSimulator>)
Stop current process of smooth simulation
Declaration
public static void SmoothSimulationStop(this ComWrapper<ICamIpcSimulator> simulatorCom)
Parameters