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
SimDebugBuilder	Returns the sim debug builder
SimulationOptionsBuilder	Returns the simulation options builder
Tag	Returns the Tag for this object.

Methods¶

Method	Description
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.
GetObject	Returns the object currently being edited by this builder.
GetShow3dMaterialRemoval	Gets the show 3d material removal @return
GetShowToolPath	Gets the show tool path @return
GetSingleStep	Gets the single step @return
GetVisualization	Gets the visualization @return
JumpToDetailsLine	Jump to details line
JumpToMachineTime	Jump to machine time
JumpToNcProgramLine	Jump to nc program line
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 @return the names of available channel
MachineControlGetCycleTime	Gets the Machine Cycle Time @return The cycle time in ms
MachineControlGetFeedRateOverrideMaximumValue	Machine Control Panel: Gets the Machine Feed Rate Override Maximum Value @return The feed rate override max value
MachineControlReadVariable	Read Variable e.
MachineControlResetMachine	Machine Control Panel: Fast Reset Machine
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
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
ResetMachine	Simulation Control Panel: (Full) Reset Machine
SaveSettingsToFile	Save simulation settings to xml file
SetShow3dMaterialRemoval	Sets the show 3d material removal @return The dialog response, if the user don’t define workpiece the autoblock dialog will displayed.
SetShowToolPath	Sets the show tool path
SetSingleStep	Sets the single step
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.
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¶

IsvControlPanelBuilderSingleStepType Enumeration	The Single Step type
IsvControlPanelBuilderVisualizationType Enumeration	The Visualization type

Property Detail¶

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”)

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”)

Method Detail¶

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”)

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

Signature GetSingleStep()

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

New in version NX8.0.0.

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 NOTE: The full Unicode character set is not supported for this parameter.

New in version NX8.0.0.

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

JumpToNcProgramLine¶

IsvControlPanelBuilder.JumpToNcProgramLine¶

Jump to nc program line

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”)

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) – NOTE: The full Unicode character set is not supported for this parameter.

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 NOTE: The full Unicode character set is not supported for this parameter. variableName (str) – The variable name NOTE: The full Unicode character set is not supported for this parameter.
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”)

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) – NOTE: The full Unicode character set is not supported for this parameter.

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”)

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) – NOTE: The full Unicode character set is not supported for this parameter.

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) – NOTE: The full Unicode character set is not supported for this parameter.

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 NOTE: The full Unicode character set is not supported for this parameter. variableName (str) – The variable name NOTE: The full Unicode character set is not supported for this parameter. variableValue (str) – The variable value NOTE: The full Unicode character set is not supported for this parameter. variableType (str) – The variable type: VDI_SWITCH, VDI_INTEGER, VDI_SINGLESTEP NOTE: The full Unicode character set is not supported for this parameter.
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 NOTE: The full Unicode character set is not supported for this parameter.

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) – NOTE: The full Unicode character set is not supported for this parameter.

New in version NX9.0.1.

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

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) – NOTE: The full Unicode character set is not supported for this parameter.

New in version NX9.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

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”)

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”)

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.