LoadSnapshotBuilder Class

class NXOpen.SIM.LoadSnapshotBuilder

Bases: NXOpen.Builder

Represents a NXOpen.SIM.LoadSnapshotBuilder

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

New in version NX12.0.0.

Properties

Property Description
RunToSimTime Returns or sets the run to simulation time
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.
GetSnapshot Returns the snapshot
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.

Property Detail

RunToSimTime

LoadSnapshotBuilder.RunToSimTime

Returns or sets the run to simulation time

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

Getter Method

Signature RunToSimTime

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature RunToSimTime

Parameters:bRunToTime (bool) –

New in version NX12.0.0.

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

Method Detail

GetSnapshot

LoadSnapshotBuilder.GetSnapshot

Returns the snapshot

Signature GetSnapshot(snapshotName, setupName)

Parameters:
  • snapshotName (str) –
  • setupName (str) –
Returns:
Return type:

NXOpen.SIM.Snapshot

New in version NX12.0.0.

License requirements: None.

Validate

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