IsvControlPanelBuilder Class¶

class NXOpen.SIM.IsvControlPanelBuilder¶

Bases: NXOpen.Builder

Represents a NXOpen.SIM.IsvControlPanelBuilder

To create a new instance of this class, use NXOpen.SIM.KinematicConfigurator.CreateIsvControlPanelBuilder()

New in version NX8.0.0.

Properties¶

Property	Description
IsInHistoryBuffer	Returns the simulation is inside history buffer
MachineConfiguratorFilename	Returns the machine configurator filename with full path
SimDebugBuilder	Returns the sim debug builder
SimulationLoadSnapshotBuilder	Returns the load snapshot builder
SimulationOptionsBuilder	Returns the simulation options builder
SimulationSaveSnapshotBuilder	Returns the save snapshot builder
Tag	Returns the Tag for this object.
VncStatus	Returns the mode of VNC

Methods¶

Method	Description
AddIsInHistoryBuffer	Registers the IsInHistoryBufferChanged callback.
AddSimEnd	Registers the SimEnd callback.
AddSimStop	Registers the SimStop callback.
AddVncStatus	Registers the VNC Status callback.
ApplySimulationOptions	Apply the simulation options
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetCurrentProgram	Returns a program currently used in the simulation
GetDetail	Return the Details Information to a specified type
GetDetailCount	Return the number of Details of the specified type
GetMachiningTimeAnalysisClock	Return the Machining Time Analysis Clock for the specified channel.
GetObject	Returns the object currently being edited by this builder.
GetPostprocessorFilename	Get the post processor definition and tcl filename with full path
GetShow3dMaterialRemoval	Gets the show 3d material removal
GetShowToolPath	Gets the show tool path
GetSingleStep	Gets the single step in Tool Path Based Simulation
GetSingleStepMode	Gets the single step mode in Machine Code Simulation
GetVisualization	Gets the visualization
JumpToDetailsLine	Jump to details line
JumpToMachineTime	Jump to machine time
JumpToNcProgramLine	Jump to nc program line in the active channel
MachineControlBootVnck	Machine Control Panel: Boot the VNCK Once booted, the vnck-machine remains booted until the part is closed or a ‘machine replace’ is executed. To shut down the vnck-machine manually, `NXOpen.SIM.IsvControlPanelBuilder.MachineControlShutdownVnck()` can be invoked.
MachineControlClearAlarm	Machine Control Panel: Clear Alarms for all channels
MachineControlDryRun	Machine Control Panel: Activate Machine Dry Run
MachineControlFeedRateOverride	Machine Control Panel: Sets Machine Feed Rate Override
MachineControlGetChannels	Gets the Channel Names
MachineControlGetCycleTime	Gets the Machine Cycle Time
MachineControlGetFeedRateOverrideMaximumValue	Machine Control Panel: Gets the Machine Feed Rate Override Maximum Value
MachineControlReadVariable	Read Variable e.
MachineControlResetMachine	Machine Control Panel: Fast Reset Machine
MachineControlResetMachineData	Machine Control Panel: Reset the Machine Data (SRAM) to the library Machine Data (SRAM)
MachineControlResetNc	Machine Control Panel: NC Reset for all channels
MachineControlResetPart	Machine Control Panel: Reset Part
MachineControlSaveMachineData	Machine Control Panel: Save the Machine Data (SRAM)
MachineControlShowHmi	Machine Control Panel: Show HMI
MachineControlShutdownVnck	Machine Control Panel: Shut down the VNCK Used in conjunction with `NXOpen.SIM.IsvControlPanelBuilder.MachineControlBootVnck()`.
MachineControlSingleBlockMode	Machine Control Panel: Activate Machine Single Block Mode
MachineControlStartNc	Machine Control Panel: NC Start for all channels
MachineControlStopNc	Machine Control Panel: NC Stop for all channels
MachineControlWriteVariable	Write Variable e.
PlayBackward	Simulation Control Panel: Play Backward
PlayForward	Simulation Control Panel: Play Forward
PlayToMachineTime	Play to Machine Time
ReadSettingsFromFile	Read simulation settings from xml file
RemoveIsInHistoryBuffer	Unregisters the IsInHistoryBufferChanged callback.
RemoveSimEnd	Unregisters the SimEnd callback.
RemoveSimStop	Unregisters the SimStop callback.
RemoveVncStatus	Unregisters the VNC Status callback.
ResetMachine	Simulation Control Panel: (Full) Reset Machine
SaveSettingsToFile	Save simulation settings to xml file
SetCurrentProgramLine	Set execution cursor to nc program line in the specified channel
SetShow3dMaterialRemoval	Sets the show 3d material removal
SetShowToolPath	Sets the show tool path
SetSingleStep	Sets the single step in Tool Path Based Simulation
SetSingleStepMode	Sets the single step mode in Machine Code Simulation
SetSpeed	Simulation Control Panel: Simulation Speed
SetVisualization	Sets the visualization
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
ShowSnapshot	Show snapshot
SingleStepBackward	Simulation Control Panel: Single Step Backward
SingleStepForward	Simulation Control Panel: Single Step Forward
StepToNextOperation	Simulation Control Panel: Step to Next Operation
StepToPreviousOperation	Simulation Control Panel: Step to Previous Operation
Stop	Simulation Control Panel: Stop the simulation
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

IsvControlPanelBuilderDetailType Enumeration	Type of record reported in the Simulation Details group
IsvControlPanelBuilderSingleStepModeType Enumeration	The Single Step Mode type that used in :py:class:` NXOpen.SIM.IsvControlPanelBuilderVisualizationType.MachineCodeSimulateCse < NXOpen.SIM.IsvControlPanelBuilderVisualizationType>` simulation mode.
IsvControlPanelBuilderSingleStepType Enumeration	The Single Step type that used in :py:class:` NXOpen.SIM.IsvControlPanelBuilderVisualizationType.MachineCodeSimulateMtd < NXOpen.SIM.IsvControlPanelBuilderVisualizationType>` or :py:class:` NXOpen.SIM.IsvControlPanelBuilderVisualizationType.ToolPathSimulation < NXOpen.SIM.IsvControlPanelBuilderVisualizationType>` simulation mode.
IsvControlPanelBuilderVisualizationType Enumeration	The Visualization type
IsvControlPanelBuilderVncMode Enumeration	Type of VNC Mode

Property Detail¶

IsInHistoryBuffer¶

IsvControlPanelBuilder.IsInHistoryBuffer¶

Returns the simulation is inside history buffer

-------------------------------------

Getter Method

Signature IsInHistoryBuffer

Returns:
Return type:	bool

New in version NX10.0.3.

License requirements: None.

MachineConfiguratorFilename¶

IsvControlPanelBuilder.MachineConfiguratorFilename¶

Returns the machine configurator filename with full path

-------------------------------------

Getter Method

Signature MachineConfiguratorFilename

Returns:	The machine configurator filename with full path
Return type:	str

New in version NX10.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SimDebugBuilder¶

IsvControlPanelBuilder.SimDebugBuilder¶

Returns the sim debug builder

-------------------------------------

Getter Method

Signature SimDebugBuilder

Returns:	the sim debug builder
Return type:	`NXOpen.SIM.SimDebugBuilder`

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SimulationLoadSnapshotBuilder¶

IsvControlPanelBuilder.SimulationLoadSnapshotBuilder¶

Returns the load snapshot builder

-------------------------------------

Getter Method

Signature SimulationLoadSnapshotBuilder

Returns:	the load snapshot builder
Return type:	`NXOpen.SIM.LoadSnapshotBuilder`

New in version NX12.0.0.

License requirements: None.

SimulationOptionsBuilder¶

IsvControlPanelBuilder.SimulationOptionsBuilder¶

Returns the simulation options builder

-------------------------------------

Getter Method

Signature SimulationOptionsBuilder

Returns:	the simulation options builder
Return type:	`NXOpen.CAM.SimulationOptionsBuilder`

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SimulationSaveSnapshotBuilder¶

IsvControlPanelBuilder.SimulationSaveSnapshotBuilder¶

Returns the save snapshot builder

-------------------------------------

Getter Method

Signature SimulationSaveSnapshotBuilder

Returns:	the save snapshot builder
Return type:	`NXOpen.SIM.SaveSnapshotBuilder`

New in version NX12.0.0.

License requirements: None.

VncStatus¶

IsvControlPanelBuilder.VncStatus¶

Returns the mode of VNC

-------------------------------------

Getter Method

Signature VncStatus

Returns:
Return type:	`NXOpen.SIM.IsvControlPanelBuilderVncMode`

New in version NX10.0.3.

License requirements: None.

Method Detail¶

AddIsInHistoryBuffer¶

IsvControlPanelBuilder.AddIsInHistoryBuffer¶

Registers the IsInHistoryBufferChanged callback.

Signature AddIsInHistoryBuffer(handler)

Parameters:	handler (CallableObject) –
Returns:
Return type:	int

New in version NX10.0.3.

License requirements: None.

AddSimEnd¶

IsvControlPanelBuilder.AddSimEnd¶

Registers the SimEnd callback.

Signature AddSimEnd(handler)

Parameters:	handler (CallableObject) –
Returns:
Return type:	int

New in version NX10.0.3.

License requirements: None.

AddSimStop¶

IsvControlPanelBuilder.AddSimStop¶

Registers the SimStop callback.

Signature AddSimStop(handler)

Parameters:	handler (CallableObject) –
Returns:
Return type:	int

New in version NX10.0.3.

License requirements: None.

AddVncStatus¶

IsvControlPanelBuilder.AddVncStatus¶

Registers the VNC Status callback.

Signature AddVncStatus(handler)

Parameters:	handler (CallableObject) –
Returns:
Return type:	int

New in version NX10.0.3.

License requirements: None.

ApplySimulationOptions¶

IsvControlPanelBuilder.ApplySimulationOptions¶

Apply the simulation options

Signature ApplySimulationOptions()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

GetCurrentProgram¶

IsvControlPanelBuilder.GetCurrentProgram¶

Returns a program currently used in the simulation

Signature GetCurrentProgram(channelName, stackLevel)

Parameters:	channelName (str) – The channel name. stackLevel (int) – The callstack level. During simulation the main program is on callstack level 0.
Returns:
Return type:	`NXOpen.SIM.NcProgram`

New in version NX12.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

GetDetail¶

IsvControlPanelBuilder.GetDetail¶

Return the Details Information to a specified type

Signature GetDetail(type, position)

Parameters:	type (`NXOpen.SIM.IsvControlPanelBuilderDetailType`) – position (int) –
Returns:	a tuple
Return type:	A tuple consisting of (result, time, description, ncLine, programName, channelName) result is a bool. time is a float. description is a str. ncLine is a int. programName is a str. channelName is a str.

New in version NX11.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

GetDetailCount¶

IsvControlPanelBuilder.GetDetailCount¶

Return the number of Details of the specified type

Signature GetDetailCount(type)

Parameters:	type (`NXOpen.SIM.IsvControlPanelBuilderDetailType`) –
Returns:
Return type:	int

New in version NX10.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

GetMachiningTimeAnalysisClock¶

IsvControlPanelBuilder.GetMachiningTimeAnalysisClock¶

Return the Machining Time Analysis Clock for the specified channel.

Signature GetMachiningTimeAnalysisClock(channelName)

Parameters:	channelName (str) – The channel name.
Returns:
Return type:	`NXOpen.SIM.TimeAnalysis`

New in version NX11.0.2.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

GetPostprocessorFilename¶

IsvControlPanelBuilder.GetPostprocessorFilename¶

Get the post processor definition and tcl filename with full path

Signature GetPostprocessorFilename()

Returns:	a tuple
Return type:	A tuple consisting of (tclFilename, definitionFilename) tclFilename is a str. The tcl filename with full pathdefinitionFilename is a str. The definition filename with full path

New in version NX10.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

GetShow3dMaterialRemoval¶

IsvControlPanelBuilder.GetShow3dMaterialRemoval¶

Gets the show 3d material removal

Signature GetShow3dMaterialRemoval()

Returns:
Return type:	bool

New in version NX8.0.0.

License requirements: None.

GetShowToolPath¶

IsvControlPanelBuilder.GetShowToolPath¶

Gets the show tool path

Signature GetShowToolPath()

Returns:
Return type:	bool

New in version NX8.0.0.

License requirements: None.

GetSingleStep¶

IsvControlPanelBuilder.GetSingleStep¶

Gets the single step in Tool Path Based Simulation

Signature GetSingleStep()

Returns:
Return type:	`NXOpen.SIM.IsvControlPanelBuilderSingleStepType`

New in version NX8.0.0.

License requirements: None.

GetSingleStepMode¶

IsvControlPanelBuilder.GetSingleStepMode¶

Gets the single step mode in Machine Code Simulation

Signature GetSingleStepMode()

Returns:
Return type:	`NXOpen.SIM.IsvControlPanelBuilderSingleStepModeType`

New in version NX10.0.2.

License requirements: None.

GetVisualization¶

IsvControlPanelBuilder.GetVisualization¶

Gets the visualization

Signature GetVisualization()

Returns:
Return type:	`NXOpen.SIM.IsvControlPanelBuilderVisualizationType`

New in version NX8.0.0.

License requirements: None.

JumpToDetailsLine¶

IsvControlPanelBuilder.JumpToDetailsLine¶

Jump to details line

Signature JumpToDetailsLine(line)

Parameters:	line (int) – The details window line

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

JumpToMachineTime¶

IsvControlPanelBuilder.JumpToMachineTime¶

Jump to machine time

Signature JumpToMachineTime(machineTime)

Parameters:	machineTime (str) – The machine time in hh:mm:ss.s format

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

JumpToNcProgramLine¶

IsvControlPanelBuilder.JumpToNcProgramLine¶

Overloaded method JumpToNcProgramLine

JumpToNcProgramLine(line)
JumpToNcProgramLine(channelName, line)

-------------------------------------

Jump to nc program line in the active channel

Signature JumpToNcProgramLine(line)

Parameters:	line (int) – The nc program window line

New in version NX8.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

Jump to nc program line in the specified channel

Signature JumpToNcProgramLine(channelName, line)

Parameters:	channelName (str) – The channel name. If this is None or empty the active channel will be used. line (int) – The nc program line

New in version NX11.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

MachineControlBootVnck¶

IsvControlPanelBuilder.MachineControlBootVnck¶

Machine Control Panel: Boot the VNCK Once booted, the vnck-machine remains booted until the part is closed or a ‘machine replace’ is executed. To shut down the vnck-machine manually, NXOpen.SIM.IsvControlPanelBuilder.MachineControlShutdownVnck() can be invoked.

The new behavior eliminates the wait required to start the machine. However, it happens that the machine must be restarted. For this purpose NXOpen.SIM.IsvControlPanelBuilder.MachineControlShutdownVnck() and NXOpen.SIM.IsvControlPanelBuilder.MachineControlBootVnck() can be successively invoked.

Signature MachineControlBootVnck()

Returns:
Return type:	bool

New in version NX11.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlClearAlarm¶

IsvControlPanelBuilder.MachineControlClearAlarm¶

Overloaded method MachineControlClearAlarm

MachineControlClearAlarm()
MachineControlClearAlarm(channels)

-------------------------------------

Machine Control Panel: Clear Alarms for all channels

Signature MachineControlClearAlarm()

New in version NX8.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

Machine Control Panel: Clear Alarms for specific channels

Signature MachineControlClearAlarm(channels)

Parameters:	channels (list of str) –

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

MachineControlDryRun¶

IsvControlPanelBuilder.MachineControlDryRun¶

Machine Control Panel: Activate Machine Dry Run

Signature MachineControlDryRun(enable)

Parameters:	enable (bool) – Enable or disable the dry run

New in version NX8.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlFeedRateOverride¶

IsvControlPanelBuilder.MachineControlFeedRateOverride¶

Machine Control Panel: Sets Machine Feed Rate Override

Signature MachineControlFeedRateOverride(value)

Parameters:	value (int) – The feed rate override value

New in version NX8.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlGetChannels¶

IsvControlPanelBuilder.MachineControlGetChannels¶

Gets the Channel Names

Signature MachineControlGetChannels()

Returns:	the names of available channel
Return type:	list of str

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlGetCycleTime¶

IsvControlPanelBuilder.MachineControlGetCycleTime¶

Gets the Machine Cycle Time

Signature MachineControlGetCycleTime()

Returns:	The cycle time in ms
Return type:	int

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlGetFeedRateOverrideMaximumValue¶

IsvControlPanelBuilder.MachineControlGetFeedRateOverrideMaximumValue¶

Machine Control Panel: Gets the Machine Feed Rate Override Maximum Value

Signature MachineControlGetFeedRateOverrideMaximumValue()

Returns:	The feed rate override max value
Return type:	int

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlReadVariable¶

IsvControlPanelBuilder.MachineControlReadVariable¶

Read Variable e.

VDI Variable, Machine Data

Signature MachineControlReadVariable(channelName, variableName)

Parameters:	channelName (str) – The channel name, NULL or empty means all channels variableName (str) – The variable name
Returns:	a tuple
Return type:	A tuple consisting of (success, variableValue, variableType) success is a bool. variableValue is a str. The variable valuevariableType is a str. The variable type: VDI_SWITCH, VDI_INTEGER, VDI_SINGLESTEP

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlResetMachine¶

IsvControlPanelBuilder.MachineControlResetMachine¶

Machine Control Panel: Fast Reset Machine

Signature MachineControlResetMachine()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlResetMachineData¶

IsvControlPanelBuilder.MachineControlResetMachineData¶

Machine Control Panel: Reset the Machine Data (SRAM) to the library Machine Data (SRAM)

Signature MachineControlResetMachineData()

New in version NX11.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlResetNc¶

IsvControlPanelBuilder.MachineControlResetNc¶

Overloaded method MachineControlResetNc

MachineControlResetNc()
MachineControlResetNc(channels)

-------------------------------------

Machine Control Panel: NC Reset for all channels

Signature MachineControlResetNc()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

Machine Control Panel: NC Reset for specific channels

Signature MachineControlResetNc(channels)

Parameters:	channels (list of str) –

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

MachineControlResetPart¶

IsvControlPanelBuilder.MachineControlResetPart¶

Machine Control Panel: Reset Part

Signature MachineControlResetPart()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlSaveMachineData¶

IsvControlPanelBuilder.MachineControlSaveMachineData¶

Machine Control Panel: Save the Machine Data (SRAM)

Signature MachineControlSaveMachineData()

New in version NX8.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlShowHmi¶

IsvControlPanelBuilder.MachineControlShowHmi¶

Machine Control Panel: Show HMI

Signature MachineControlShowHmi()

New in version NX8.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlShutdownVnck¶

IsvControlPanelBuilder.MachineControlShutdownVnck¶

Machine Control Panel: Shut down the VNCK Used in conjunction with NXOpen.SIM.IsvControlPanelBuilder.MachineControlBootVnck().

Signature MachineControlShutdownVnck()

New in version NX11.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlSingleBlockMode¶

IsvControlPanelBuilder.MachineControlSingleBlockMode¶

Machine Control Panel: Activate Machine Single Block Mode

Signature MachineControlSingleBlockMode(enable)

Parameters:	enable (bool) – Enable or disable the single block mode

New in version NX8.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

MachineControlStartNc¶

IsvControlPanelBuilder.MachineControlStartNc¶

Overloaded method MachineControlStartNc

MachineControlStartNc()
MachineControlStartNc(channels)

-------------------------------------

Machine Control Panel: NC Start for all channels

Signature MachineControlStartNc()

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

Machine Control Panel: NC Start for specific channels

Signature MachineControlStartNc(channels)

Parameters:	channels (list of str) –

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

MachineControlStopNc¶

IsvControlPanelBuilder.MachineControlStopNc¶

Overloaded method MachineControlStopNc

MachineControlStopNc()
MachineControlStopNc(channels)

-------------------------------------

Machine Control Panel: NC Stop for all channels

Signature MachineControlStopNc()

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

Machine Control Panel: NC Stop for specific channels

Signature MachineControlStopNc(channels)

Parameters:	channels (list of str) –

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

-------------------------------------

MachineControlWriteVariable¶

IsvControlPanelBuilder.MachineControlWriteVariable¶

Write Variable e.

VDI Variable, Machine Data

Signature MachineControlWriteVariable(channelName, variableName, variableValue, variableType)

Parameters:	channelName (str) – The channel name, NULL or empty means all channels variableName (str) – The variable name variableValue (str) – The variable value variableType (str) – The variable type: VDI_SWITCH, VDI_INTEGER, VDI_SINGLESTEP
Returns:
Return type:	bool

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

PlayBackward¶

IsvControlPanelBuilder.PlayBackward¶

Simulation Control Panel: Play Backward

Signature PlayBackward()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

PlayForward¶

IsvControlPanelBuilder.PlayForward¶

Simulation Control Panel: Play Forward

Signature PlayForward()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

PlayToMachineTime¶

IsvControlPanelBuilder.PlayToMachineTime¶

Play to Machine Time

Signature PlayToMachineTime(machineTime)

Parameters:	machineTime (str) – The machine time in hh:mm:ss.s format

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

ReadSettingsFromFile¶

IsvControlPanelBuilder.ReadSettingsFromFile¶

Read simulation settings from xml file

Signature ReadSettingsFromFile(filename)

Parameters:	filename (str) –

New in version NX9.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

RemoveIsInHistoryBuffer¶

IsvControlPanelBuilder.RemoveIsInHistoryBuffer¶

Unregisters the IsInHistoryBufferChanged callback.

Signature RemoveIsInHistoryBuffer(handlerId)

Parameters:	handlerId (int) –
Returns:
Return type:	bool

New in version NX10.0.3.

License requirements: None.

RemoveSimEnd¶

IsvControlPanelBuilder.RemoveSimEnd¶

Unregisters the SimEnd callback.

Signature RemoveSimEnd(handlerId)

Parameters:	handlerId (int) –
Returns:
Return type:	bool

New in version NX10.0.3.

License requirements: None.

RemoveSimStop¶

IsvControlPanelBuilder.RemoveSimStop¶

Unregisters the SimStop callback.

Signature RemoveSimStop(handlerId)

Parameters:	handlerId (int) –
Returns:
Return type:	bool

New in version NX10.0.3.

License requirements: None.

RemoveVncStatus¶

IsvControlPanelBuilder.RemoveVncStatus¶

Unregisters the VNC Status callback.

Signature RemoveVncStatus(handlerId)

Parameters:	handlerId (int) –
Returns:
Return type:	bool

New in version NX10.0.3.

License requirements: None.

ResetMachine¶

IsvControlPanelBuilder.ResetMachine¶

Simulation Control Panel: (Full) Reset Machine

Signature ResetMachine()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SaveSettingsToFile¶

IsvControlPanelBuilder.SaveSettingsToFile¶

Save simulation settings to xml file

Signature SaveSettingsToFile(filename)

Parameters:	filename (str) –

New in version NX9.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SetCurrentProgramLine¶

IsvControlPanelBuilder.SetCurrentProgramLine¶

Set execution cursor to nc program line in the specified channel

Signature SetCurrentProgramLine(channelName, line)

Parameters:	channelName (str) – The channel name. If this is None or empty the active channel will be used. line (int) – The nc program line

New in version NX11.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SetShow3dMaterialRemoval¶

IsvControlPanelBuilder.SetShow3dMaterialRemoval¶

Sets the show 3d material removal

Signature SetShow3dMaterialRemoval(state)

Parameters:	state (bool) – The state
Returns:	The dialog response,

if the user don’t define workpiece the autoblock dialog will displayed. And if the user cancel it the response is UGII_CANCEL :rtype: int

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SetShowToolPath¶

IsvControlPanelBuilder.SetShowToolPath¶

Sets the show tool path

Signature SetShowToolPath(state)

Parameters:	state (bool) – The state

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SetSingleStep¶

IsvControlPanelBuilder.SetSingleStep¶

Sets the single step in Tool Path Based Simulation

Signature SetSingleStep(type)

Parameters:	type (`NXOpen.SIM.IsvControlPanelBuilderSingleStepType`) – The single step type

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SetSingleStepMode¶

IsvControlPanelBuilder.SetSingleStepMode¶

Sets the single step mode in Machine Code Simulation

Signature SetSingleStepMode(type)

Parameters:	type (`NXOpen.SIM.IsvControlPanelBuilderSingleStepModeType`) – The single step mode type

New in version NX10.0.2.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SetSpeed¶

IsvControlPanelBuilder.SetSpeed¶

Simulation Control Panel: Simulation Speed

Signature SetSpeed(simSpeed)

Parameters:	simSpeed (int) – The simulation speed

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SetVisualization¶

IsvControlPanelBuilder.SetVisualization¶

Sets the visualization

Signature SetVisualization(type)

Parameters:	type (`NXOpen.SIM.IsvControlPanelBuilderVisualizationType`) – The visualization type

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

ShowSnapshot¶

IsvControlPanelBuilder.ShowSnapshot¶

Show snapshot

Signature ShowSnapshot(bRunToSimTime, snapshot)

Parameters:	bRunToSimTime (bool) – snapshot (`NXOpen.SIM.Snapshot`) – The snapshot

New in version NX12.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SingleStepBackward¶

IsvControlPanelBuilder.SingleStepBackward¶

Simulation Control Panel: Single Step Backward

Signature SingleStepBackward()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

SingleStepForward¶

IsvControlPanelBuilder.SingleStepForward¶

Simulation Control Panel: Single Step Forward

Signature SingleStepForward()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

StepToNextOperation¶

IsvControlPanelBuilder.StepToNextOperation¶

Simulation Control Panel: Step to Next Operation

Signature StepToNextOperation()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

StepToPreviousOperation¶

IsvControlPanelBuilder.StepToPreviousOperation¶

Simulation Control Panel: Step to Previous Operation

Signature StepToPreviousOperation()

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

Stop¶

IsvControlPanelBuilder.Stop¶

Simulation Control Panel: Stop the simulation

Signature Stop()

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

Validate¶

IsvControlPanelBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.