ArchiveImportBuilder Class

class NXOpen.SIM.ArchiveImportBuilder

Bases: NXOpen.Builder

Represents a ArchiveImportBuilder builder object.

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

New in version NX9.0.3.

Properties

Property Description
FileName Returns or sets the archive file name from which to import data
ImportCollisionAvoidance Returns or sets the setting for importing collision avoidance data.
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.
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

FileName

ArchiveImportBuilder.FileName

Returns or sets the archive file name from which to import data

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

Getter Method

Signature FileName

Returns:The archive file name
Return type:str

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature FileName

Parameters:fileName (str) – The new archive file name

New in version NX9.0.3.

License requirements: None.

ImportCollisionAvoidance

ArchiveImportBuilder.ImportCollisionAvoidance

Returns or sets the setting for importing collision avoidance data.

If true then collision avoidance data will be imported instead of the machine configuration.

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

Getter Method

Signature ImportCollisionAvoidance

Returns:The setting for importing collision avoidance data
Return type:bool

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature ImportCollisionAvoidance

Parameters:importSetting (bool) – The new setting for importing collision avoidance data

New in version NX9.0.3.

License requirements: None.

Method Detail

Validate

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