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

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::SIM::IsvControlPanelBuilder:

Public Types
enum	SingleStepType { SingleStepTypeBlock, SingleStepTypeMove, SingleStepTypeEvent, SingleStepTypeStepOut, SingleStepTypeStepIn, SingleStepTypeDisplay }
	The Single Step type. More...

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

Public Member Functions
void	ApplySimulationOptions ()
	Apply the simulation options Created in NX8.0.0.

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

bool	GetShowToolPath ()
	Gets the show tool path.

NXOpen::SIM::IsvControlPanelBuilder::SingleStepType	GetSingleStep ()
	Gets the single step.

NXOpen::SIM::IsvControlPanelBuilder::VisualizationType	GetVisualization ()
	Gets the visualization.

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

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

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

void	JumpToNcProgramLine (int line)
	Jump to nc program line Created in NX8.5.0.

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

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

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

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

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

int	MachineControlGetCycleTime ()
	Gets the Machine Cycle Time.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	SetSingleStep (NXOpen::SIM::IsvControlPanelBuilder::SingleStepType type)
	Sets the single step Created in NX8.0.0.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::SIM::IsvControlPanelBuilder::SingleStepType

The Single Step type.

Enumerator:

SingleStepTypeBlock	Block.
SingleStepTypeMove	Move.
SingleStepTypeEvent	Event.
SingleStepTypeStepOut	Step Out.
SingleStepTypeStepIn	Step In.
SingleStepTypeDisplay	Display.

enum NXOpen::SIM::IsvControlPanelBuilder::VisualizationType

The Visualization type.

Enumerator:

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

Member Function Documentation

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

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

Gets the show 3d material removal.

Returns: Created in NX8.0.0.

License requirements : None

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

Gets the show tool path.

Returns: Created in NX8.0.0.

License requirements : None

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

Gets the single step.

Returns: Created in NX8.0.0.

License requirements : None

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

Gets the visualization.

Returns: Created in NX8.0.0.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
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
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::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

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::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")

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

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

SIM_IsvControlPanelBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation