SimDebugBuilder Class

class NXOpen.SIM.SimDebugBuilder

Bases: NXOpen.Builder

Represents a NXOpen.SIM.SimDebugBuilder

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

New in version NX8.0.0.

Properties

Property Description
Driver Returns or sets the driver
Dump Returns or sets the dump
DumpOutput Returns or sets the dump output
DumpToFileName Returns or sets the output filename
KinematicModel Returns or sets the kinematic model
PrintoutTags Returns or sets the printout tags type
Tag Returns the Tag for this object.

Methods

Method Description
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.
GetTrace Gets the trace
GetUiSetting Gets the debug setting
SetTrace Sets the trace
SetUiSetting Sets the debug setting
ShowKinematicModelState Show the kinematic model state
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

SimDebugBuilderDriverType Enumeration Represents the driver type
SimDebugBuilderDumpType Enumeration Represents the dump type
SimDebugBuilderKinematicModelType Enumeration Represents the kinematic model type
SimDebugBuilderOutputType Enumeration The output type
SimDebugBuilderPrintoutTagsOrPointersType Enumeration Represents the printout tags or pointers type
SimDebugBuilderTraceType Enumeration Represents the trace type
SimDebugBuilderUiType Enumeration Represents the ui type

Property Detail

Driver

SimDebugBuilder.Driver

Returns or sets the driver

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

Getter Method

Signature Driver

Returns:
Return type:NXOpen.SIM.SimDebugBuilderDriverType

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Driver

Parameters:type (NXOpen.SIM.SimDebugBuilderDriverType) – The driver type

New in version NX8.0.0.

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

Dump

SimDebugBuilder.Dump

Returns or sets the dump

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

Getter Method

Signature Dump

Returns:The dump type
Return type:NXOpen.SIM.SimDebugBuilderDumpType

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Dump

Parameters:type (NXOpen.SIM.SimDebugBuilderDumpType) – The dump type

New in version NX8.0.0.

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

DumpOutput

SimDebugBuilder.DumpOutput

Returns or sets the dump output

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

Getter Method

Signature DumpOutput

Returns:The dump output type
Return type:NXOpen.SIM.SimDebugBuilderOutputType

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature DumpOutput

Parameters:type (NXOpen.SIM.SimDebugBuilderOutputType) – The dump output type

New in version NX8.0.0.

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

DumpToFileName

SimDebugBuilder.DumpToFileName

Returns or sets the output filename

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

Getter Method

Signature DumpToFileName

Returns:The output name
Return type:str

New in version NX8.0.0.

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

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

Setter Method

Signature DumpToFileName

Parameters:name (str) – the output new name

New in version NX8.0.0.

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

KinematicModel

SimDebugBuilder.KinematicModel

Returns or sets the kinematic model

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

Getter Method

Signature KinematicModel

Returns:
Return type:NXOpen.SIM.SimDebugBuilderKinematicModelType

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature KinematicModel

Parameters:type (NXOpen.SIM.SimDebugBuilderKinematicModelType) – The kinematic model type

New in version NX8.0.0.

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

PrintoutTags

SimDebugBuilder.PrintoutTags

Returns or sets the printout tags type

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

Getter Method

Signature PrintoutTags

Returns:The printout tags type
Return type:NXOpen.SIM.SimDebugBuilderPrintoutTagsOrPointersType

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature PrintoutTags

Parameters:type (NXOpen.SIM.SimDebugBuilderPrintoutTagsOrPointersType) – The printout tags type

New in version NX8.5.0.

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

Method Detail

GetTrace

SimDebugBuilder.GetTrace

Gets the trace

Signature GetTrace(type)

Parameters:type (NXOpen.SIM.SimDebugBuilderTraceType) – The trace type
Returns:The state
Return type:bool

New in version NX8.0.0.

License requirements: None.

GetUiSetting

SimDebugBuilder.GetUiSetting

Gets the debug setting

Signature GetUiSetting(type)

Parameters:type (NXOpen.SIM.SimDebugBuilderUiType) – The ui type
Returns:The state
Return type:bool

New in version NX8.0.0.

License requirements: None.

SetTrace

SimDebugBuilder.SetTrace

Sets the trace

Signature SetTrace(type, state)

Parameters:

New in version NX8.0.0.

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

SetUiSetting

SimDebugBuilder.SetUiSetting

Sets the debug setting

Signature SetUiSetting(type, state)

Parameters:

New in version NX8.0.0.

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

ShowKinematicModelState

SimDebugBuilder.ShowKinematicModelState

Show the kinematic model state

Signature ShowKinematicModelState()

New in version NX8.0.0.

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

Validate

SimDebugBuilder.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.