Represents a NXOpen::SIM::IsvControlPanelBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateIsvControlPanelBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::SIM::IsvControlPanelBuilder:

Public Types
enum	DetailType { DetailTypeInfo, DetailTypeController, DetailTypeLimit, DetailTypeCollision, DetailTypeGouge, DetailTypeSingularity }
	Type of record reported in the Simulation Details group. More...

typedef NXOpen::Callback1 < void, bool >	IsInHistoryBufferCb
	Prototype for IsInHistoryBufferChanged callbacks Created in NX10.0.3. More...

typedef NXOpen::Callback0< void >	SimEndCb
	Prototype for SimEnd callbacks Created in NX10.0.3. More...

typedef NXOpen::Callback0< void >	SimStopCb
	Prototype for SimStop callbacks Created in NX10.0.3. More...

enum	SingleStepModeType { SingleStepModeTypeStepIn, SingleStepModeTypeStepOver, SingleStepModeTypeStepOut, SingleStepModeTypeDisplayUpdate }
	The Single Step Mode type that used in NXOpen::SIM::IsvControlPanelBuilder::VisualizationTypeMachineCodeSimulateCse simulation mode. More...

enum	SingleStepType { SingleStepTypeBlock, SingleStepTypeMove, SingleStepTypeEvent }
	The Single Step type that used in NXOpen::SIM::IsvControlPanelBuilder::VisualizationTypeMachineCodeSimulateMtd or NXOpen::SIM::IsvControlPanelBuilder::VisualizationTypeToolPathSimulation simulation mode. More...

enum	VisualizationType { VisualizationTypeMachineCodeSimulateCse, VisualizationTypeMachineCodeSimulateMtd, VisualizationTypeToolPathSimulation }
	The Visualization type. More...

enum	VncMode { VncModeError = -1, VncModeNotconnected, VncModeConnected, VncModeBooted, VncModeConfigured, VncModeInitialized, VncModeProgramsLoaded, VncModeReset, VncModeStop, VncModeStart, VncModeRun }
	Type of VNC Mode. More...

typedef NXOpen::Callback1 < void, NXOpen::SIM::IsvControlPanelBuilder::VncMode >	VncStatusCb
	Prototype for VNC Status callbacks Created in NX10.0.3. More...

Public Member Functions
NXString	ActiveChannel ()
	Returns the active channel in simulation. More...

int	AddIsInHistoryBuffer (const NXOpen::SIM::IsvControlPanelBuilder::IsInHistoryBufferCb &handler)
	Registers the IsInHistoryBufferChanged callback. More...

int	AddSimEnd (const NXOpen::SIM::IsvControlPanelBuilder::SimEndCb &handler)
	Registers the SimEnd callback. More...

int	AddSimStop (const NXOpen::SIM::IsvControlPanelBuilder::SimStopCb &handler)
	Registers the SimStop callback. More...

int	AddVncStatus (const NXOpen::SIM::IsvControlPanelBuilder::VncStatusCb &handler)
	Registers the VNC Status callback. More...

void	ApplySimulationOptions ()
	Apply the simulation options Created in NX8.0.0. More...

void	CheckProgramSyntax (const std::vector< NXOpen::SIM::NcProgram * > &programs)
	Check the syntax of nc programs. More...

NXOpen::SIM::NcProgram *	GetCurrentProgram (const NXString &channelName, int stackLevel)
	Returns a program currently used in the simulation Created in NX12.0.0. More...

NXOpen::SIM::NcProgram *	GetCurrentProgram (const char *channelName, int stackLevel)
	Returns a program currently used in the simulation Created in NX12.0.0. More...

bool	GetDetail (NXOpen::SIM::IsvControlPanelBuilder::DetailType type, int position, double time, NXString description, int ncLine, NXString programName, NXString *channelName)
	Return the Details Information to a specified type Created in NX11.0.0. More...

int	GetDetailCount (NXOpen::SIM::IsvControlPanelBuilder::DetailType type)
	Return the number of Details of the specified type Created in NX10.0.1. More...

NXOpen::SIM::TimeAnalysis *	GetMachiningTimeAnalysisClock (const NXString &channelName)
	Return the Machining Time Analysis Clock for the specified channel. More...

NXOpen::SIM::TimeAnalysis *	GetMachiningTimeAnalysisClock (const char *channelName)
	Return the Machining Time Analysis Clock for the specified channel. More...

NXString	GetPostprocessorFilename (NXString *definitionFilename)
	Get the post processor definition and tcl filename with full path. More...

bool	GetShow3dMaterialRemoval ()
	Gets the show 3d material removal More...

bool	GetShowToolPath ()
	Gets the show tool path Created in NX8.0.0. More...

NXOpen::SIM::IsvControlPanelBuilder::SingleStepType	GetSingleStep ()
	Gets the single step in Tool Path Based Simulation Created in NX8.0.0. More...

NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeType	GetSingleStepMode ()
	Gets the single step mode in Machine Code Simulation Created in NX10.0.2. More...

NXOpen::SIM::IsvControlPanelBuilder::VisualizationType	GetVisualization ()
	Gets the visualization Created in NX8.0.0. More...

bool	IsInHistoryBuffer ()
	Returns the simulation is inside history buffer Created in NX10.0.3. More...

void	JumpToDetailsLine (int line)
	Jump to details line Created in NX8.0.0. More...

void	JumpToMachineTime (const NXString &machineTime)
	Jump to machine time Created in NX8.0.0. More...

void	JumpToMachineTime (const char *machineTime)
	Jump to machine time Created in NX8.0.0. More...

void	JumpToNcProgramLine (int line)
	Jump to nc program line in the active channel Created in NX8.5.0. More...

void	JumpToNcProgramLine (const NXString &channelName, int line)
	Jump to nc program line in the specified channel Created in NX11.0.1. More...

void	JumpToNcProgramLine (const char *channelName, int line)
	Jump to nc program line in the specified channel Created in NX11.0.1. More...

NXString	MachineConfiguratorFilename ()
	Returns the machine configurator filename with full path Created in NX10.0.1. More...

bool	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. More...

void	MachineControlClearAlarm ()
	Machine Control Panel: Clear Alarms for all channels Created in NX8.5.0. More...

void	MachineControlClearAlarm (std::vector< NXString > &channels)
	Machine Control Panel: Clear Alarms for specific channels Created in NX9.0.0. More...

void	MachineControlDryRun (bool enable)
	Machine Control Panel: Activate Machine Dry Run Created in NX8.5.0. More...

void	MachineControlFeedRateOverride (int value)
	Machine Control Panel: Sets Machine Feed Rate Override Created in NX8.5.0. More...

std::vector< NXString >	MachineControlGetChannels ()
	Gets the Channel Names. More...

int	MachineControlGetCycleTime ()
	Gets the Machine Cycle Time. More...

int	MachineControlGetFeedRateOverrideMaximumValue ()
	Machine Control Panel: Gets the Machine Feed Rate Override Maximum Value. More...

bool	MachineControlReadVariable (const NXString &channelName, const NXString &variableName, NXString variableValue, NXString variableType)
	Read Variable e.g. More...

bool	MachineControlReadVariable (const char channelName, const char variableName, NXString variableValue, NXString variableType)
	Read Variable e.g. More...

void	MachineControlResetMachine ()
	Machine Control Panel: Fast Reset Machine Created in NX8.0.0. More...

void	MachineControlResetMachineData ()
	Machine Control Panel: Reset the Machine Data (SRAM) to the library Machine Data (SRAM) Created in NX11.0.1. More...

void	MachineControlResetNc ()
	Machine Control Panel: NC Reset for all channels Created in NX8.0.0. More...

void	MachineControlResetNc (std::vector< NXString > &channels)
	Machine Control Panel: NC Reset for specific channels Created in NX9.0.0. More...

void	MachineControlResetPart ()
	Machine Control Panel: Reset Part Created in NX8.0.0. More...

void	MachineControlSaveMachineData ()
	Machine Control Panel: Save the Machine Data (SRAM) Created in NX8.5.0. More...

void	MachineControlShowHmi ()
	Machine Control Panel: Show HMI Created in NX8.5.0. More...

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

void	MachineControlSingleBlockMode (bool enable)
	Machine Control Panel: Activate Machine Single Block Mode Created in NX8.5.0. More...

void	MachineControlStartNc ()
	Machine Control Panel: NC Start for all channels Created in NX9.0.0. More...

void	MachineControlStartNc (std::vector< NXString > &channels)
	Machine Control Panel: NC Start for specific channels Created in NX9.0.0. More...

void	MachineControlStopNc ()
	Machine Control Panel: NC Stop for all channels Created in NX9.0.0. More...

void	MachineControlStopNc (std::vector< NXString > &channels)
	Machine Control Panel: NC Stop for specific channels Created in NX9.0.0. More...

bool	MachineControlWriteVariable (const NXString &channelName, const NXString &variableName, const NXString &variableValue, const NXString &variableType)
	Write Variable e.g. More...

bool	MachineControlWriteVariable (const char channelName, const char variableName, const char variableValue, const char variableType)
	Write Variable e.g. More...

void	PlayBackward ()
	Simulation Control Panel: Play Backward Created in NX8.0.0. More...

void	PlayForward ()
	Simulation Control Panel: Play Forward Created in NX8.0.0. More...

void	PlayToMachineTime (const NXString &machineTime)
	Play to Machine Time Created in NX8.0.0. More...

void	PlayToMachineTime (const char *machineTime)
	Play to Machine Time Created in NX8.0.0. More...

void	ReadSettingsFromFile (const NXString &filename)
	Read simulation settings from xml file Created in NX9.0.1. More...

void	ReadSettingsFromFile (const char *filename)
	Read simulation settings from xml file Created in NX9.0.1. More...

bool	RemoveIsInHistoryBuffer (int handlerId)
	Unregisters the IsInHistoryBufferChanged callback. More...

bool	RemoveSimEnd (int handlerId)
	Unregisters the SimEnd callback. More...

bool	RemoveSimStop (int handlerId)
	Unregisters the SimStop callback. More...

bool	RemoveVncStatus (int handlerId)
	Unregisters the VNC Status callback. More...

void	ResetMachine ()
	Simulation Control Panel: (Full) Reset Machine Created in NX8.0.0. More...

void	SaveSettingsToFile (const NXString &filename)
	Save simulation settings to xml file Created in NX9.0.1. More...

void	SaveSettingsToFile (const char *filename)
	Save simulation settings to xml file Created in NX9.0.1. More...

void	SetActiveChannel (const NXString &channelName)
	Sets the active channel in simulation. More...

void	SetActiveChannel (const char *channelName)
	Sets the active channel in simulation. More...

void	SetCurrentProgramLine (const NXString &channelName, int line)
	Set execution cursor to nc program line in the specified channel Created in NX11.0.1. More...

void	SetCurrentProgramLine (const char *channelName, int line)
	Set execution cursor to nc program line in the specified channel Created in NX11.0.1. More...

int	SetShow3dMaterialRemoval (bool state)
	Sets the show 3d material removal. More...

void	SetShowToolPath (bool state)
	Sets the show tool path Created in NX8.0.0. More...

void	SetSingleStep (NXOpen::SIM::IsvControlPanelBuilder::SingleStepType type)
	Sets the single step in Tool Path Based Simulation Created in NX8.0.0. More...

void	SetSingleStepMode (NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeType type)
	Sets the single step mode in Machine Code Simulation Created in NX10.0.2. More...

void	SetSpeed (int simSpeed)
	Simulation Control Panel: Simulation Speed Created in NX8.0.0. More...

void	SetVisualization (NXOpen::SIM::IsvControlPanelBuilder::VisualizationType type)
	Sets the visualization Created in NX8.0.0. More...

void	ShowSnapshot (bool bRunToSimTime, NXOpen::SIM::Snapshot *snapshot)
	Show snapshot More...

void	ShowSnapshot (bool bRunToSimTime, const NXString &setupName, NXOpen::SIM::Snapshot *snapshot)
	Show snapshot Created in NX12.0.2. More...

void	ShowSnapshot (bool bRunToSimTime, const char setupName, NXOpen::SIM::Snapshot snapshot)
	Show snapshot Created in NX12.0.2. More...

NXOpen::SIM::SimDebugBuilder *	SimDebugBuilder ()
	Returns the sim debug builder Created in NX8.0.0. More...

NXOpen::SIM::LoadSnapshotBuilder *	SimulationLoadSnapshotBuilder ()
	Returns the load snapshot builder Created in NX12.0.0. More...

NXOpen::CAM::SimulationOptionsBuilder *	SimulationOptionsBuilder ()
	Returns the simulation options builder Created in NX8.0.0. More...

NXOpen::SIM::SaveSnapshotBuilder *	SimulationSaveSnapshotBuilder ()
	Returns the save snapshot builder Created in NX12.0.0. More...

void	SingleStepBackward ()
	Simulation Control Panel: Single Step Backward Created in NX8.0.0. More...

void	SingleStepForward ()
	Simulation Control Panel: Single Step Forward Created in NX8.0.0. More...

void	StepToNextOperation ()
	Simulation Control Panel: Step to Next Operation Created in NX8.0.0. More...

void	StepToPreviousOperation ()
	Simulation Control Panel: Step to Previous Operation Created in NX8.0.0. More...

void	Stop ()
	Simulation Control Panel: Stop the simulation Created in NX9.0.0. More...

NXOpen::SIM::IsvControlPanelBuilder::VncMode	VncStatus ()
	Returns the mode of VNC Created in NX10.0.3. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::SIM::IsvControlPanelBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateIsvControlPanelBuilder

Created in NX8.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<void, bool> NXOpen::SIM::IsvControlPanelBuilder::IsInHistoryBufferCb

Prototype for IsInHistoryBufferChanged callbacks
Created in NX10.0.3.

License requirements : None

typedef NXOpen::Callback0<void> NXOpen::SIM::IsvControlPanelBuilder::SimEndCb

Prototype for SimEnd callbacks
Created in NX10.0.3.

License requirements : None

typedef NXOpen::Callback0<void> NXOpen::SIM::IsvControlPanelBuilder::SimStopCb

Prototype for SimStop callbacks
Created in NX10.0.3.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::SIM::IsvControlPanelBuilder::VncMode> NXOpen::SIM::IsvControlPanelBuilder::VncStatusCb

Prototype for VNC Status callbacks
Created in NX10.0.3.

License requirements : None

Member Enumeration Documentation

enum NXOpen::SIM::IsvControlPanelBuilder::DetailType

Type of record reported in the Simulation Details group.

Enumerator
DetailTypeInfo	Info.
DetailTypeController	Controller.
DetailTypeLimit	Limit.
DetailTypeCollision	Collision.
DetailTypeGouge	Gouge.
DetailTypeSingularity	Singularity.

enum NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeType

The Single Step Mode type that used in NXOpen::SIM::IsvControlPanelBuilder::VisualizationTypeMachineCodeSimulateCse simulation mode.

Enumerator
SingleStepModeTypeStepIn	Step In.
SingleStepModeTypeStepOver	Step Over.
SingleStepModeTypeStepOut	Step Out.
SingleStepModeTypeDisplayUpdate	Display.

enum NXOpen::SIM::IsvControlPanelBuilder::SingleStepType

The Single Step type that used in NXOpen::SIM::IsvControlPanelBuilder::VisualizationTypeMachineCodeSimulateMtd or NXOpen::SIM::IsvControlPanelBuilder::VisualizationTypeToolPathSimulation simulation mode.

The following NXOpen::SIM::IsvControlPanelBuilder::SingleStepType members are removed in NX10.0.2:

StepOut
StepIn
Display Replacement: Use the following NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeType member instead:
NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeTypeStepOut
NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeTypeStepIn
NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeTypeDisplayUpdate

Enumerator
SingleStepTypeBlock	Block.
SingleStepTypeMove	Move.
SingleStepTypeEvent	Event.

enum NXOpen::SIM::IsvControlPanelBuilder::VisualizationType

The Visualization type.

Enumerator
VisualizationTypeMachineCodeSimulateCse	Machine Code Simulate Cse.
VisualizationTypeMachineCodeSimulateMtd	Machine Code Simulate Mtd.
VisualizationTypeToolPathSimulation	Tool Path Simulate.

enum NXOpen::SIM::IsvControlPanelBuilder::VncMode

Type of VNC Mode.

Enumerator
VncModeError	ERROR.
VncModeNotconnected	NOT CONNECTED.
VncModeConnected	CONNECTED.
VncModeBooted	BOOTED.
VncModeConfigured	CONFIGURED.
VncModeInitialized	INITIALIZED.
VncModeProgramsLoaded	PROGRAMS LOADED.
VncModeReset	RESET.
VncModeStop	STOP.
VncModeStart	START.
VncModeRun	RUN.

Member Function Documentation

NXString NXOpen::SIM::IsvControlPanelBuilder::ActiveChannel ( )

Returns the active channel in simulation.

Created in NX1847.0.0.

License requirements : None

int NXOpen::SIM::IsvControlPanelBuilder::AddIsInHistoryBuffer ( const NXOpen::SIM::IsvControlPanelBuilder::IsInHistoryBufferCb & handler )

Registers the IsInHistoryBufferChanged callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handler handler

int NXOpen::SIM::IsvControlPanelBuilder::AddSimEnd ( const NXOpen::SIM::IsvControlPanelBuilder::SimEndCb & handler )

Registers the SimEnd callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handler handler

int NXOpen::SIM::IsvControlPanelBuilder::AddSimStop ( const NXOpen::SIM::IsvControlPanelBuilder::SimStopCb & handler )

Registers the SimStop callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handler handler

int NXOpen::SIM::IsvControlPanelBuilder::AddVncStatus ( const NXOpen::SIM::IsvControlPanelBuilder::VncStatusCb & handler )

Registers the VNC Status callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handler handler

void NXOpen::SIM::IsvControlPanelBuilder::ApplySimulationOptions ( )

Apply the simulation options
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::CheckProgramSyntax ( const std::vector< NXOpen::SIM::NcProgram * > & programs )

Check the syntax of nc programs.

Created in NX12.0.2.

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

Parameters

programs nc programs where the syntax should be checked.

NXOpen::SIM::NcProgram* NXOpen::SIM::IsvControlPanelBuilder::GetCurrentProgram	(	const NXString &	channelName,
		int	stackLevel
	)

Returns a program currently used in the simulation
Created in NX12.0.0.

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

Parameters

channelName	The channel name.
stackLevel	The callstack level. During simulation the main program is on callstack level 0.

NXOpen::SIM::NcProgram* NXOpen::SIM::IsvControlPanelBuilder::GetCurrentProgram	(	const char *	channelName,
		int	stackLevel
	)

Returns a program currently used in the simulation
Created in NX12.0.0.

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

Parameters

channelName	The channel name.
stackLevel	The callstack level. During simulation the main program is on callstack level 0.

bool NXOpen::SIM::IsvControlPanelBuilder::GetDetail	(	NXOpen::SIM::IsvControlPanelBuilder::DetailType	type,
		int	position,
		double *	time,
		NXString *	description,
		int *	ncLine,
		NXString *	programName,
		NXString *	channelName
	)

Return the Details Information to a specified type
Created in NX11.0.0.

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

Parameters

type	type
position	position
time	time
description	description
ncLine	ncline
programName	programname
channelName	channelname

int NXOpen::SIM::IsvControlPanelBuilder::GetDetailCount ( NXOpen::SIM::IsvControlPanelBuilder::DetailType type )

Return the number of Details of the specified type
Created in NX10.0.1.

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

Parameters

type type

NXOpen::SIM::TimeAnalysis* NXOpen::SIM::IsvControlPanelBuilder::GetMachiningTimeAnalysisClock ( const NXString & channelName )

Return the Machining Time Analysis Clock for the specified channel.

Created in NX11.0.2.

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

Parameters

channelName The channel name.

NXOpen::SIM::TimeAnalysis* NXOpen::SIM::IsvControlPanelBuilder::GetMachiningTimeAnalysisClock ( const char * channelName )

Return the Machining Time Analysis Clock for the specified channel.

Created in NX11.0.2.

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

Parameters

channelName The channel name.

NXString NXOpen::SIM::IsvControlPanelBuilder::GetPostprocessorFilename ( NXString * definitionFilename )

Get the post processor definition and tcl filename with full path.

Returns: The tcl filename with full path
Created in NX10.0.1.

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

Parameters

definitionFilename The definition filename with full path

bool NXOpen::SIM::IsvControlPanelBuilder::GetShow3dMaterialRemoval ( )

Gets the show 3d material removal

Deprecated:: Deprecated in NX12.0.1.

Use CAM::SimulationOptionsBuilder::EnableMaterialRemoval and CAM::SimulationOptionsBuilder::DisplayIpw instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::SIM::IsvControlPanelBuilder::GetShowToolPath ( )

Gets the show tool path
Created in NX8.0.0.

License requirements : None

NXOpen::SIM::IsvControlPanelBuilder::SingleStepType NXOpen::SIM::IsvControlPanelBuilder::GetSingleStep ( )

Gets the single step in Tool Path Based Simulation
Created in NX8.0.0.

License requirements : None

NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeType NXOpen::SIM::IsvControlPanelBuilder::GetSingleStepMode ( )

Gets the single step mode in Machine Code Simulation
Created in NX10.0.2.

License requirements : None

NXOpen::SIM::IsvControlPanelBuilder::VisualizationType NXOpen::SIM::IsvControlPanelBuilder::GetVisualization ( )

Gets the visualization
Created in NX8.0.0.

License requirements : None

bool NXOpen::SIM::IsvControlPanelBuilder::IsInHistoryBuffer ( )

Returns the simulation is inside history buffer
Created in NX10.0.3.

License requirements : None

void NXOpen::SIM::IsvControlPanelBuilder::JumpToDetailsLine ( int line )

Jump to details line
Created in NX8.0.0.

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

Parameters

line	The details window line

void NXOpen::SIM::IsvControlPanelBuilder::JumpToMachineTime ( const NXString & machineTime )

Jump to machine time
Created in NX8.0.0.

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

Parameters

machineTime The machine time in hh:mm:ss.s format

void NXOpen::SIM::IsvControlPanelBuilder::JumpToMachineTime ( const char * machineTime )

Jump to machine time
Created in NX8.0.0.

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

Parameters

machineTime The machine time in hh:mm:ss.s format

void NXOpen::SIM::IsvControlPanelBuilder::JumpToNcProgramLine ( int line )

Jump to nc program line in the active channel
Created in NX8.5.0.

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

Parameters

line	The nc program window line

void NXOpen::SIM::IsvControlPanelBuilder::JumpToNcProgramLine	(	const NXString &	channelName,
		int	line
	)

Jump to nc program line in the specified channel
Created in NX11.0.1.

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

Parameters

channelName	The channel name. If this is NULL or empty the active channel will be used.
line	The nc program line

void NXOpen::SIM::IsvControlPanelBuilder::JumpToNcProgramLine	(	const char *	channelName,
		int	line
	)

Jump to nc program line in the specified channel
Created in NX11.0.1.

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

Parameters

channelName	The channel name. If this is NULL or empty the active channel will be used.
line	The nc program line

NXString NXOpen::SIM::IsvControlPanelBuilder::MachineConfiguratorFilename ( )

Returns the machine configurator filename with full path
Created in NX10.0.1.

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

bool NXOpen::SIM::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.

Created in NX11.0.1.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlClearAlarm ( )

Machine Control Panel: Clear Alarms for all channels
Created in NX8.5.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlClearAlarm ( std::vector< NXString > & channels )

Machine Control Panel: Clear Alarms for specific channels
Created in NX9.0.0.

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

Parameters

channels channels

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlDryRun ( bool enable )

Machine Control Panel: Activate Machine Dry Run
Created in NX8.5.0.

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

Parameters

enable Enable or disable the dry run

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlFeedRateOverride ( int value )

Machine Control Panel: Sets Machine Feed Rate Override
Created in NX8.5.0.

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

Parameters

value The feed rate override value

std::vector<NXString> NXOpen::SIM::IsvControlPanelBuilder::MachineControlGetChannels ( )

Gets the Channel Names.

Returns: the names of available channel
Created in NX9.0.0.

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

int NXOpen::SIM::IsvControlPanelBuilder::MachineControlGetCycleTime ( )

Gets the Machine Cycle Time.

Returns: The cycle time in ms
Created in NX9.0.0.

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

int NXOpen::SIM::IsvControlPanelBuilder::MachineControlGetFeedRateOverrideMaximumValue ( )

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

Returns: The feed rate override max value
Created in NX9.0.0.

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

bool NXOpen::SIM::IsvControlPanelBuilder::MachineControlReadVariable	(	const NXString &	channelName,
		const NXString &	variableName,
		NXString *	variableValue,
		NXString *	variableType
	)

Read Variable e.g.

VDI Variable, Machine Data
Created in NX9.0.0.

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

Parameters

channelName	The channel name, NULL or empty means all channels
variableName	The variable name
variableValue	The variable value
variableType	The variable type: VDI_SWITCH, VDI_INTEGER, VDI_SINGLESTEP

bool NXOpen::SIM::IsvControlPanelBuilder::MachineControlReadVariable	(	const char *	channelName,
		const char *	variableName,
		NXString *	variableValue,
		NXString *	variableType
	)

Read Variable e.g.

VDI Variable, Machine Data
Created in NX9.0.0.

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

Parameters

channelName	The channel name, NULL or empty means all channels
variableName	The variable name
variableValue	The variable value
variableType	The variable type: VDI_SWITCH, VDI_INTEGER, VDI_SINGLESTEP

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlResetMachine ( )

Machine Control Panel: Fast Reset Machine
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlResetMachineData ( )

Machine Control Panel: Reset the Machine Data (SRAM) to the library Machine Data (SRAM)
Created in NX11.0.1.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlResetNc ( )

Machine Control Panel: NC Reset for all channels
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlResetNc ( std::vector< NXString > & channels )

Machine Control Panel: NC Reset for specific channels
Created in NX9.0.0.

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

Parameters

channels channels

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlResetPart ( )

Machine Control Panel: Reset Part
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlSaveMachineData ( )

Machine Control Panel: Save the Machine Data (SRAM)
Created in NX8.5.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlShowHmi ( )

Machine Control Panel: Show HMI
Created in NX8.5.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlShutdownVnck ( )

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

Created in NX11.0.1.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlSingleBlockMode ( bool enable )

Machine Control Panel: Activate Machine Single Block Mode
Created in NX8.5.0.

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

Parameters

enable Enable or disable the single block mode

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlStartNc ( )

Machine Control Panel: NC Start for all channels
Created in NX9.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlStartNc ( std::vector< NXString > & channels )

Machine Control Panel: NC Start for specific channels
Created in NX9.0.0.

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

Parameters

channels channels

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlStopNc ( )

Machine Control Panel: NC Stop for all channels
Created in NX9.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::MachineControlStopNc ( std::vector< NXString > & channels )

Machine Control Panel: NC Stop for specific channels
Created in NX9.0.0.

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

Parameters

channels channels

bool NXOpen::SIM::IsvControlPanelBuilder::MachineControlWriteVariable	(	const NXString &	channelName,
		const NXString &	variableName,
		const NXString &	variableValue,
		const NXString &	variableType
	)

Write Variable e.g.

VDI Variable, Machine Data
Created in NX9.0.0.

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

Parameters

channelName	The channel name, NULL or empty means all channels
variableName	The variable name
variableValue	The variable value
variableType	The variable type: VDI_SWITCH, VDI_INTEGER, VDI_SINGLESTEP

bool NXOpen::SIM::IsvControlPanelBuilder::MachineControlWriteVariable	(	const char *	channelName,
		const char *	variableName,
		const char *	variableValue,
		const char *	variableType
	)

Write Variable e.g.

VDI Variable, Machine Data
Created in NX9.0.0.

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

Parameters

channelName	The channel name, NULL or empty means all channels
variableName	The variable name
variableValue	The variable value
variableType	The variable type: VDI_SWITCH, VDI_INTEGER, VDI_SINGLESTEP

void NXOpen::SIM::IsvControlPanelBuilder::PlayBackward ( )

Simulation Control Panel: Play Backward
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::PlayForward ( )

Simulation Control Panel: Play Forward
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::PlayToMachineTime ( const NXString & machineTime )

Play to Machine Time
Created in NX8.0.0.

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

Parameters

machineTime The machine time in hh:mm:ss.s format

void NXOpen::SIM::IsvControlPanelBuilder::PlayToMachineTime ( const char * machineTime )

Play to Machine Time
Created in NX8.0.0.

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

Parameters

machineTime The machine time in hh:mm:ss.s format

void NXOpen::SIM::IsvControlPanelBuilder::ReadSettingsFromFile ( const NXString & filename )

Read simulation settings from xml file
Created in NX9.0.1.

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

Parameters

filename filename

void NXOpen::SIM::IsvControlPanelBuilder::ReadSettingsFromFile ( const char * filename )

Read simulation settings from xml file
Created in NX9.0.1.

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

Parameters

filename filename

bool NXOpen::SIM::IsvControlPanelBuilder::RemoveIsInHistoryBuffer ( int handlerId )

Unregisters the IsInHistoryBufferChanged callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handlerId handlerid

bool NXOpen::SIM::IsvControlPanelBuilder::RemoveSimEnd ( int handlerId )

Unregisters the SimEnd callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handlerId handlerid

bool NXOpen::SIM::IsvControlPanelBuilder::RemoveSimStop ( int handlerId )

Unregisters the SimStop callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handlerId handlerid

bool NXOpen::SIM::IsvControlPanelBuilder::RemoveVncStatus ( int handlerId )

Unregisters the VNC Status callback.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

handlerId handlerid

void NXOpen::SIM::IsvControlPanelBuilder::ResetMachine ( )

Simulation Control Panel: (Full) Reset Machine
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::SaveSettingsToFile ( const NXString & filename )

Save simulation settings to xml file
Created in NX9.0.1.

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

Parameters

filename filename

void NXOpen::SIM::IsvControlPanelBuilder::SaveSettingsToFile ( const char * filename )

Save simulation settings to xml file
Created in NX9.0.1.

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

Parameters

filename filename

void NXOpen::SIM::IsvControlPanelBuilder::SetActiveChannel ( const NXString & channelName )

Sets the active channel in simulation.

Created in NX1847.0.0.

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

Parameters

channelName Name of the channel.

void NXOpen::SIM::IsvControlPanelBuilder::SetActiveChannel ( const char * channelName )

Sets the active channel in simulation.

Created in NX1847.0.0.

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

Parameters

channelName Name of the channel.

void NXOpen::SIM::IsvControlPanelBuilder::SetCurrentProgramLine	(	const NXString &	channelName,
		int	line
	)

Set execution cursor to nc program line in the specified channel
Created in NX11.0.1.

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

Parameters

channelName	The channel name. If this is NULL or empty the active channel will be used.
line	The nc program line

void NXOpen::SIM::IsvControlPanelBuilder::SetCurrentProgramLine	(	const char *	channelName,
		int	line
	)

Set execution cursor to nc program line in the specified channel
Created in NX11.0.1.

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

Parameters

channelName	The channel name. If this is NULL or empty the active channel will be used.
line	The nc program line

int NXOpen::SIM::IsvControlPanelBuilder::SetShow3dMaterialRemoval ( bool state )

Sets the show 3d material removal.

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

Deprecated:: Deprecated in NX12.0.1. Use CAM::SimulationOptionsBuilder::SetEnableMaterialRemoval and CAM::SimulationOptionsBuilder::SetDisplayIpw instead.

Created in NX8.0.0.

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

Parameters

state The state

void NXOpen::SIM::IsvControlPanelBuilder::SetShowToolPath ( bool state )

Sets the show tool path
Created in NX8.0.0.

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

Parameters

state The state

void NXOpen::SIM::IsvControlPanelBuilder::SetSingleStep ( NXOpen::SIM::IsvControlPanelBuilder::SingleStepType type )

Sets the single step in Tool Path Based Simulation
Created in NX8.0.0.

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

Parameters

type	The single step type

void NXOpen::SIM::IsvControlPanelBuilder::SetSingleStepMode ( NXOpen::SIM::IsvControlPanelBuilder::SingleStepModeType type )

Sets the single step mode in Machine Code Simulation
Created in NX10.0.2.

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

Parameters

type	The single step mode type

void NXOpen::SIM::IsvControlPanelBuilder::SetSpeed ( int simSpeed )

Simulation Control Panel: Simulation Speed
Created in NX8.0.0.

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

Parameters

simSpeed The simulation speed

void NXOpen::SIM::IsvControlPanelBuilder::SetVisualization ( NXOpen::SIM::IsvControlPanelBuilder::VisualizationType type )

Sets the visualization
Created in NX8.0.0.

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

Parameters

type	The visualization type

void NXOpen::SIM::IsvControlPanelBuilder::ShowSnapshot	(	bool	bRunToSimTime,
		NXOpen::SIM::Snapshot *	snapshot
	)

Show snapshot

Deprecated:: Deprecated in NX12.0.2.

Use new version with additional arguments instead.

Created in NX12.0.0.

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

Parameters

bRunToSimTime	bruntosimtime
snapshot	The snapshot

void NXOpen::SIM::IsvControlPanelBuilder::ShowSnapshot	(	bool	bRunToSimTime,
		const NXString &	setupName,
		NXOpen::SIM::Snapshot *	snapshot
	)

Show snapshot
Created in NX12.0.2.

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

Parameters

bRunToSimTime	bruntosimtime
setupName	setupname
snapshot	The snapshot

void NXOpen::SIM::IsvControlPanelBuilder::ShowSnapshot	(	bool	bRunToSimTime,
		const char *	setupName,
		NXOpen::SIM::Snapshot *	snapshot
	)

Show snapshot
Created in NX12.0.2.

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

Parameters

bRunToSimTime	bruntosimtime
setupName	setupname
snapshot	The snapshot

NXOpen::SIM::SimDebugBuilder* NXOpen::SIM::IsvControlPanelBuilder::SimDebugBuilder ( )

Returns the sim debug builder
Created in NX8.0.0.

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

NXOpen::SIM::LoadSnapshotBuilder* NXOpen::SIM::IsvControlPanelBuilder::SimulationLoadSnapshotBuilder ( )

Returns the load snapshot builder
Created in NX12.0.0.

License requirements : None

NXOpen::CAM::SimulationOptionsBuilder* NXOpen::SIM::IsvControlPanelBuilder::SimulationOptionsBuilder ( )

Returns the simulation options builder
Created in NX8.0.0.

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

NXOpen::SIM::SaveSnapshotBuilder* NXOpen::SIM::IsvControlPanelBuilder::SimulationSaveSnapshotBuilder ( )

Returns the save snapshot builder
Created in NX12.0.0.

License requirements : None

void NXOpen::SIM::IsvControlPanelBuilder::SingleStepBackward ( )

Simulation Control Panel: Single Step Backward
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::SingleStepForward ( )

Simulation Control Panel: Single Step Forward
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::StepToNextOperation ( )

Simulation Control Panel: Step to Next Operation
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::StepToPreviousOperation ( )

Simulation Control Panel: Step to Previous Operation
Created in NX8.0.0.

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

void NXOpen::SIM::IsvControlPanelBuilder::Stop ( )

Simulation Control Panel: Stop the simulation
Created in NX9.0.0.

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

NXOpen::SIM::IsvControlPanelBuilder::VncMode NXOpen::SIM::IsvControlPanelBuilder::VncStatus ( )

Returns the mode of VNC
Created in NX10.0.3.

License requirements : None

The documentation for this class was generated from the following file:

SIM_IsvControlPanelBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation