Represents a NXOpen::SIM::SimDebugBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateSimDebugBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::SIM::SimDebugBuilder:

Public Types
enum	DriverType { DriverTypeCse, DriverTypeMtd }
	Represents the driver type. More...

enum	DumpType { DumpTypeNone, DumpTypeKinematicModel, DumpTypeHighlighting, DumpTypeIpw, DumpTypeCollision, DumpTypeOutputBuffer, DumpTypeTime, DumpTypeDetails, DumpTypeSynchronizeUi, DumpTypeSynchronizeManagerXtp, DumpTypeEngineParams, DumpTypeMomVariables, DumpTypeDebugUi, DumpTypeSimulationSettings, DumpTypeSimManager, DumpTypePathEvents, DumpTypeMachiningTimeAnalysis }
	Represents the dump type. More...

enum	KinematicModelType { KinematicModelTypeMain, KinematicModelTypeSimulation, KinematicModelTypeDriver }
	Represents the kinematic model type. More...

enum	OutputType { OutputTypeSyslog, OutputTypeListingWindow, OutputTypeAutotest, OutputTypeToFile }
	The output type. More...

enum	PrintoutTagsOrPointersType { PrintoutTagsOrPointersTypeBoolean, PrintoutTagsOrPointersTypeValue, PrintoutTagsOrPointersTypeName }
	Represents the printout tags or pointers type. More...

enum	TraceType { TraceTypeButtonDown, TraceTypeVcr, TraceTypeIpw, TraceTypePerformance, TraceTypeCollision, TraceTypeGouge, TraceTypeHighlighting, TraceTypeDetails, TraceTypePositionalIsv, TraceTypeSpinningNonSpinning, TraceTypeKinematicModel, TraceTypeEvent, TraceTypeLineServer, TraceTypeSync, TraceTypeDctkSettings, TraceTypeDctkMovements, TraceTypeDctkDisplay, TraceTypeDctkCollision, TraceTypeToolPathPicking }
	Represents the trace type. More...

enum	UiType { UiTypeDisplayMomEvent, UiTypeShowPartAndTipJunctions, UiTypeGenerateSpinningTools, UiTypeUseHybridGougeChecker, UiTypeUseMtbOldDialogs, UiTypeUseFastTicker, UiTypePrintOutTraceSerialNumbers, UiTypePerformanceDisplayDetail, UiTypePerformanceDisplayTime, UiTypePerformanceIndentTime, UiTypePerformanceDisplayData, UiTypeDctkWriteCollisionPairs }
	Represents the ui type. More...

Public Member Functions
NXOpen::SIM::SimDebugBuilder::DriverType	Driver ()
	Returns the driver Created in NX8.0.0. More...

NXOpen::SIM::SimDebugBuilder::DumpType	Dump ()
	Returns the dump Created in NX8.0.0. More...

NXOpen::SIM::SimDebugBuilder::OutputType	DumpOutput ()
	Returns the dump output Created in NX8.0.0. More...

NXString	DumpToFileName ()
	Returns the output filename Created in NX8.0.0. More...

bool	GetTrace (NXOpen::SIM::SimDebugBuilder::TraceType type)
	Gets the trace. More...

bool	GetUiSetting (NXOpen::SIM::SimDebugBuilder::UiType type)
	Gets the debug setting. More...

NXOpen::SIM::SimDebugBuilder::KinematicModelType	KinematicModel ()
	Returns the kinematic model Created in NX8.0.0. More...

NXOpen::SIM::SimDebugBuilder::PrintoutTagsOrPointersType	PrintoutTags ()
	Returns the printout tags type Created in NX8.5.0. More...

void	SetDriver (NXOpen::SIM::SimDebugBuilder::DriverType type)
	Sets the driver Created in NX8.0.0. More...

void	SetDump (NXOpen::SIM::SimDebugBuilder::DumpType type)
	Sets the dump Created in NX8.0.0. More...

void	SetDumpOutput (NXOpen::SIM::SimDebugBuilder::OutputType type)
	Sets the dump output Created in NX8.0.0. More...

void	SetDumpToFileName (const NXString &name)
	Sets the output filename Created in NX8.0.0. More...

void	SetDumpToFileName (const char *name)
	Sets the output filename Created in NX8.0.0. More...

void	SetKinematicModel (NXOpen::SIM::SimDebugBuilder::KinematicModelType type)
	Sets the kinematic model Created in NX8.0.0. More...

void	SetPrintoutTags (NXOpen::SIM::SimDebugBuilder::PrintoutTagsOrPointersType type)
	Sets the printout tags type Created in NX8.5.0. More...

void	SetTrace (NXOpen::SIM::SimDebugBuilder::TraceType type, bool state)
	Sets the trace Created in NX8.0.0. More...

void	SetUiSetting (NXOpen::SIM::SimDebugBuilder::UiType type, bool state)
	Sets the debug setting Created in NX8.0.0. More...

void	ShowKinematicModelState ()
	Show the kinematic model state Created in NX8.0.0. 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::SimDebugBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateSimDebugBuilder

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::SIM::SimDebugBuilder::DriverType

Represents the driver type.

Enumerator
DriverTypeCse	CSE driver.
DriverTypeMtd	MTD driver.

enum NXOpen::SIM::SimDebugBuilder::DumpType

Represents the dump type.

Enumerator
DumpTypeNone	Dump Nothing.
DumpTypeKinematicModel	Dump Kinematic Model.
DumpTypeHighlighting	Dump Highlighting.
DumpTypeIpw	Dump IPW.
DumpTypeCollision	Dump Collision.
DumpTypeOutputBuffer	Dump Output Buffer.
DumpTypeTime	Dump Time.
DumpTypeDetails	Dump Details.
DumpTypeSynchronizeUi	Dump Synchronize UI.
DumpTypeSynchronizeManagerXtp	Dump SynchronizeManagerXtp.
DumpTypeEngineParams	Dump Engine Params.
DumpTypeMomVariables	Dump Mom Variables.
DumpTypeDebugUi	Dump Debug UI.
DumpTypeSimulationSettings	Dump Simulation Settings.
DumpTypeSimManager	Dump SimManager.
DumpTypePathEvents	Dump Path Events.
DumpTypeMachiningTimeAnalysis	Dump Machining Time Analysis.

enum NXOpen::SIM::SimDebugBuilder::KinematicModelType

Represents the kinematic model type.

Enumerator
KinematicModelTypeMain	Main Kinematic Model.
KinematicModelTypeSimulation	Simulation Kinematic Model.
KinematicModelTypeDriver	Driver Kinematic Model.

enum NXOpen::SIM::SimDebugBuilder::OutputType

The output type.

Enumerator
OutputTypeSyslog	Output to syslog.
OutputTypeListingWindow	Output to listing window.
OutputTypeAutotest	Output to autotest.
OutputTypeToFile	Output to file.

enum NXOpen::SIM::SimDebugBuilder::PrintoutTagsOrPointersType

Represents the printout tags or pointers type.

Enumerator
PrintoutTagsOrPointersTypeBoolean	Boolean.
PrintoutTagsOrPointersTypeValue	Value.
PrintoutTagsOrPointersTypeName	Name.

enum NXOpen::SIM::SimDebugBuilder::TraceType

Represents the trace type.

Enumerator
TraceTypeButtonDown	Trace Button Down.
TraceTypeVcr	Trace Vcr.
TraceTypeIpw	Trace Ipw.
TraceTypePerformance	Trace Performance.
TraceTypeCollision	Trace Collision.
TraceTypeGouge	Trace Gouge.
TraceTypeHighlighting	Trace Highlighting.
TraceTypeDetails	Trace Details.
TraceTypePositionalIsv	Trace Positional Isv.
TraceTypeSpinningNonSpinning	Trace Spinning Nonspinning.
TraceTypeKinematicModel	Trace Kinematic Model.
TraceTypeEvent	Trace Event.
TraceTypeLineServer	Trace Line Server.
TraceTypeSync	Trace Sync.
TraceTypeDctkSettings	Trace Dctk Settings.
TraceTypeDctkMovements	Trace Dctk Movements.
TraceTypeDctkDisplay	Trace Dctk Display.
TraceTypeDctkCollision	Trace Dctk Collision.
TraceTypeToolPathPicking	Trace ToolPath Picking.

enum NXOpen::SIM::SimDebugBuilder::UiType

Represents the ui type.

Enumerator
UiTypeDisplayMomEvent	Display Mom Event.
UiTypeShowPartAndTipJunctions	Show Part And Tip Junction.
UiTypeGenerateSpinningTools	Generate Spinning Tools.
UiTypeUseHybridGougeChecker	Use Hybrid Gouge Checker.
UiTypeUseMtbOldDialogs	Use MTB Old Dialogs.
UiTypeUseFastTicker	Use Fast Ticker.
UiTypePrintOutTraceSerialNumbers	Print Out Trace Serial Numbers.
UiTypePerformanceDisplayDetail	Performance Display Detail.
UiTypePerformanceDisplayTime	Performance Display Time.
UiTypePerformanceIndentTime	Performance Indent Time.
UiTypePerformanceDisplayData	Performance Display Data.
UiTypeDctkWriteCollisionPairs	Write Collision Pairs.

Member Function Documentation

NXOpen::SIM::SimDebugBuilder::DriverType NXOpen::SIM::SimDebugBuilder::Driver ( )

Returns the driver
Created in NX8.0.0.

License requirements : None

NXOpen::SIM::SimDebugBuilder::DumpType NXOpen::SIM::SimDebugBuilder::Dump ( )

Returns the dump
Created in NX8.0.0.

License requirements : None

NXOpen::SIM::SimDebugBuilder::OutputType NXOpen::SIM::SimDebugBuilder::DumpOutput ( )

Returns the dump output
Created in NX8.0.0.

License requirements : None

NXString NXOpen::SIM::SimDebugBuilder::DumpToFileName ( )

Returns the output filename
Created in NX8.0.0.

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

bool NXOpen::SIM::SimDebugBuilder::GetTrace ( NXOpen::SIM::SimDebugBuilder::TraceType type )

Gets the trace.

Returns: The state
Created in NX8.0.0.

License requirements : None

Parameters

type	The trace type

bool NXOpen::SIM::SimDebugBuilder::GetUiSetting ( NXOpen::SIM::SimDebugBuilder::UiType type )

Gets the debug setting.

Returns: The state
Created in NX8.0.0.

License requirements : None

Parameters

type	The ui type

NXOpen::SIM::SimDebugBuilder::KinematicModelType NXOpen::SIM::SimDebugBuilder::KinematicModel ( )

Returns the kinematic model
Created in NX8.0.0.

License requirements : None

NXOpen::SIM::SimDebugBuilder::PrintoutTagsOrPointersType NXOpen::SIM::SimDebugBuilder::PrintoutTags ( )

Returns the printout tags type
Created in NX8.5.0.

License requirements : None

void NXOpen::SIM::SimDebugBuilder::SetDriver ( NXOpen::SIM::SimDebugBuilder::DriverType type )

Sets the driver
Created in NX8.0.0.

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

Parameters

type	The driver type

void NXOpen::SIM::SimDebugBuilder::SetDump ( NXOpen::SIM::SimDebugBuilder::DumpType type )

Sets the dump
Created in NX8.0.0.

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

Parameters

type	The dump type

void NXOpen::SIM::SimDebugBuilder::SetDumpOutput ( NXOpen::SIM::SimDebugBuilder::OutputType type )

Sets the dump output
Created in NX8.0.0.

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

Parameters

type	The dump output type

void NXOpen::SIM::SimDebugBuilder::SetDumpToFileName ( const NXString & name )

Sets the output filename
Created in NX8.0.0.

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

Parameters

name	the output new name

void NXOpen::SIM::SimDebugBuilder::SetDumpToFileName ( const char * name )

Sets the output filename
Created in NX8.0.0.

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

Parameters

name	the output new name

void NXOpen::SIM::SimDebugBuilder::SetKinematicModel ( NXOpen::SIM::SimDebugBuilder::KinematicModelType type )

Sets the kinematic model
Created in NX8.0.0.

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

Parameters

type	The kinematic model type

void NXOpen::SIM::SimDebugBuilder::SetPrintoutTags ( NXOpen::SIM::SimDebugBuilder::PrintoutTagsOrPointersType type )

Sets the printout tags type
Created in NX8.5.0.

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

Parameters

type	The printout tags type

void NXOpen::SIM::SimDebugBuilder::SetTrace	(	NXOpen::SIM::SimDebugBuilder::TraceType	type,
		bool	state
	)

Sets the trace
Created in NX8.0.0.

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

Parameters

type	The trace type
state	The state

void NXOpen::SIM::SimDebugBuilder::SetUiSetting	(	NXOpen::SIM::SimDebugBuilder::UiType	type,
		bool	state
	)

Sets the debug setting
Created in NX8.0.0.

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

Parameters

type	The ui type
state	The state

void NXOpen::SIM::SimDebugBuilder::ShowKinematicModelState ( )

Show the kinematic model state
Created in NX8.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_SimDebugBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation