SaveSnapshotBuilder Class

class NXOpen.SIM.SaveSnapshotBuilder

Bases: NXOpen.Builder

Represents a NXOpen.SIM.SaveSnapshotBuilder

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

New in version NX12.0.0.

Properties

Property Description
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.
SetSetupName Sets the setup name
SetSnapshotName Sets the snapshot name
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.

Method Detail

SetSetupName

SaveSnapshotBuilder.SetSetupName

Sets the setup name

Signature SetSetupName(name)

Parameters:name (str) – The setup name

New in version NX12.0.0.

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

SetSnapshotName

SaveSnapshotBuilder.SetSnapshotName

Sets the snapshot name

Signature SetSnapshotName(name)

Parameters:name (str) – The snapshot name

New in version NX12.0.0.

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

Validate

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