LoadOptions Class¶
-
class
NXOpen.LoadOptions¶ Bases:
objectContains accessor methods for all the part load options.
To obtain an instance of this class, refer to
NXOpen.PartCollectionNew in version NX3.0.0.
Properties¶
| Property | Description |
|---|---|
| AbortOnFailure | Returns or sets the option that specifies what action the system should take if it can’t find a component part file |
| AllowSubstitution | Returns or sets the allow substition option. |
| BookmarkRefsetLoadBehavior | Returns or sets the options that specify import and loading of components’ reference sets when opening bookmarks. |
| ComponentLoadMethod | Returns or sets the option indicating what method to use to determine where to find component parts to load |
| ComponentsToLoad | Returns or sets the option indicating what component parts to load during part open. |
| GenerateMissingPartFamilyMembers | Returns or sets the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly |
| LoadLatest | Returns or sets the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match. |
| ManagedModeComponentLoadMethod | Returns or sets the option indicating what method to use to determine how to configure assembly structure in managed mode |
| OptionUpdateSubsetOnLoad | Returns or sets the option that controls the subset updates during load |
| PartLoadOption | Returns or sets the option that controls how the part is being loaded |
| ReferenceSetOverride | Returns or sets the option that specifies if the default reference set list should be applied to components all the way down an assembly tree. |
| UseLightweightRepresentations | Returns or sets the option that controls if components are displayed with a lightweight or exact representation. |
| UsePartialLoading | Returns or sets the option that controls the partial loading of components. |
Methods¶
| Method | Description |
|---|---|
| GetBookmarkComponentsToLoad | The options for component parts to load and visualize when a bookmark is loaded. |
| GetDefaultReferenceSets | Returns the list of reference sets to be looked for, in order, when an assembly is loaded. |
| GetInterpartData | Returns the interpart data option and the parent option |
| GetSearchDirectories | Returns which search directories are to appear in the list. |
| Restore | Changes the load options settings to what they are in the specified file |
| Save | Saves the current load options settings in a system file |
| SetBookmarkComponentsToLoad | |
| SetDefaultReferenceSets | Sets the list of reference sets to be looked for, in order, when an assembly is loaded. |
| SetInterpartData | Sets the interpart data option which, when turned on, loads parts that are mated or contain interpart expressions, as well as those with WAVE data. |
| SetSearchDirectories | Set which search directories are to appear in the list. |
Enumerations¶
| LoadOptionsBookmarkComponents Enumeration | The options to specify what components to load and visualize when loading bookmarks. |
| LoadOptionsBookmarkRefsets Enumeration | the options that specify if reference set data from the bookmark should be restored and load should be optimized by loading topology from the selected reference sets only. |
| LoadOptionsLoadComponents Enumeration | Options for specifying what component parts to load during part open |
| LoadOptionsLoadMethod Enumeration | Options for specifying how to load component parts |
| LoadOptionsLoadOption Enumeration | Option to control how much data is loaded from parts. |
| LoadOptionsManagedModeLoadMethod Enumeration | Options for specifying how to configure assembly structure in managed mode |
| LoadOptionsParent Enumeration | Options to allow you to specify how unloaded parents should be loaded when interpart data loading is turned on |
| LoadOptionsUpdateSubsetOnLoad Enumeration | Options for specifying what type of subset updation to be carried out while loading |
Property Detail¶
AbortOnFailure¶
-
LoadOptions.AbortOnFailure¶ Returns or sets the option that specifies what action the system should take if it can’t find a component part file
-------------------------------------Getter Method
Signature
AbortOnFailureReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AbortOnFailureParameters: option (bool) – New in version NX3.0.0.
License requirements: None.
AllowSubstitution¶
-
LoadOptions.AllowSubstitution¶ Returns or sets the allow substition option.
If the component found by the assembly has the wrong internal identifier (but the correct name), this option enables the assembly to be loaded with this component even though it is a completely different part.
-------------------------------------Getter Method
Signature
AllowSubstitutionReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AllowSubstitutionParameters: option (bool) – New in version NX3.0.0.
License requirements: None.
BookmarkRefsetLoadBehavior¶
-
LoadOptions.BookmarkRefsetLoadBehavior¶ Returns or sets the options that specify import and loading of components’ reference sets when opening bookmarks.
-------------------------------------Getter Method
Signature
BookmarkRefsetLoadBehaviorReturns: reference set option Return type: NXOpen.LoadOptionsBookmarkRefsetsNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BookmarkRefsetLoadBehaviorParameters: refsetLoadOption ( NXOpen.LoadOptionsBookmarkRefsets) – what to do with reference set dataNew in version NX6.0.0.
License requirements: None.
ComponentLoadMethod¶
-
LoadOptions.ComponentLoadMethod¶ Returns or sets the option indicating what method to use to determine where to find component parts to load
-------------------------------------Getter Method
Signature
ComponentLoadMethodReturns: Return type: NXOpen.LoadOptionsLoadMethodNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ComponentLoadMethodParameters: option ( NXOpen.LoadOptionsLoadMethod) –New in version NX3.0.0.
License requirements: None.
ComponentsToLoad¶
-
LoadOptions.ComponentsToLoad¶ Returns or sets the option indicating what component parts to load during part open.
Note that this property cannot be set to
NXOpen.LoadOptionsLoadComponents.LastFilterorNXOpen.LoadOptionsLoadComponents.SpecifyFilterwithout an adv_assemblies license. A license exception will be thrown if an attempt is made to set this property to one of these two values without this license.-------------------------------------Getter Method
Signature
ComponentsToLoadReturns: Return type: NXOpen.LoadOptionsLoadComponentsNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ComponentsToLoadParameters: option ( NXOpen.LoadOptionsLoadComponents) –New in version NX3.0.0.
License requirements: None.
GenerateMissingPartFamilyMembers¶
-
LoadOptions.GenerateMissingPartFamilyMembers¶ Returns or sets the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly
-------------------------------------Getter Method
Signature
GenerateMissingPartFamilyMembersReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GenerateMissingPartFamilyMembersParameters: option (bool) – New in version NX3.0.0.
License requirements: None.
LoadLatest¶
-
LoadOptions.LoadLatest¶ Returns or sets the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match.
-------------------------------------Getter Method
Signature
LoadLatestReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LoadLatestParameters: option (bool) – New in version NX3.0.0.
License requirements: None.
ManagedModeComponentLoadMethod¶
-
LoadOptions.ManagedModeComponentLoadMethod¶ Returns or sets the option indicating what method to use to determine how to configure assembly structure in managed mode
-------------------------------------Getter Method
Signature
ManagedModeComponentLoadMethodReturns: Return type: NXOpen.LoadOptionsManagedModeLoadMethodNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ManagedModeComponentLoadMethodParameters: option ( NXOpen.LoadOptionsManagedModeLoadMethod) –New in version NX8.5.0.
License requirements: None.
OptionUpdateSubsetOnLoad¶
-
LoadOptions.OptionUpdateSubsetOnLoad¶ Returns or sets the option that controls the subset updates during load
-------------------------------------Getter Method
Signature
OptionUpdateSubsetOnLoadReturns: Return type: NXOpen.LoadOptionsUpdateSubsetOnLoadNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OptionUpdateSubsetOnLoadParameters: option ( NXOpen.LoadOptionsUpdateSubsetOnLoad) –New in version NX8.5.0.
License requirements: None.
PartLoadOption¶
-
LoadOptions.PartLoadOption¶ Returns or sets the option that controls how the part is being loaded
-------------------------------------Getter Method
Signature
PartLoadOptionReturns: Return type: NXOpen.LoadOptionsLoadOptionNew in version NX12.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
-------------------------------------Setter Method
Signature
PartLoadOptionParameters: loadOption ( NXOpen.LoadOptionsLoadOption) –New in version NX12.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
ReferenceSetOverride¶
-
LoadOptions.ReferenceSetOverride¶ Returns or sets the option that specifies if the default reference set list should be applied to components all the way down an assembly tree.
This option is referred to as “Apply to All Levels” in the User Interface.
-------------------------------------Getter Method
Signature
ReferenceSetOverrideReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReferenceSetOverrideParameters: option (bool) – New in version NX3.0.0.
License requirements: None.
UseLightweightRepresentations¶
-
LoadOptions.UseLightweightRepresentations¶ Returns or sets the option that controls if components are displayed with a lightweight or exact representation.
A value of True indicates that the lightweight representation is used for the components after the assembly is loaded
-------------------------------------Getter Method
Signature
UseLightweightRepresentationsReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseLightweightRepresentationsParameters: option (bool) – New in version NX7.5.0.
License requirements: None.
UsePartialLoading¶
-
LoadOptions.UsePartialLoading¶ Returns or sets the option that controls the partial loading of components.
A value of False means that when an assembly is opened its components are fully loaded with it
-------------------------------------Getter Method
Signature
UsePartialLoadingReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UsePartialLoadingParameters: option (bool) – New in version NX3.0.0.
License requirements: None.
Method Detail¶
GetBookmarkComponentsToLoad¶
-
LoadOptions.GetBookmarkComponentsToLoad¶ The options for component parts to load and visualize when a bookmark is loaded.
Signature
GetBookmarkComponentsToLoad()Returns: a tuple Return type: A tuple consisting of (restoreAnt, componentsLoadOption). restoreAnt is a bool. whether to restore ANT’s state componentsLoadOption is a NXOpen.LoadOptionsBookmarkComponents. what components to loadNew in version NX6.0.0.
License requirements: None.
GetDefaultReferenceSets¶
-
LoadOptions.GetDefaultReferenceSets¶ Returns the list of reference sets to be looked for, in order, when an assembly is loaded.
The default reference set list will always contain the four canned default reference sets: “As Saved”, “Use Model”, “Entire Part”, and “Empty”.
Signature
GetDefaultReferenceSets()Returns: Return type: list of str New in version NX3.0.0.
License requirements: None.
GetInterpartData¶
-
LoadOptions.GetInterpartData¶ Returns the interpart data option and the parent option
Signature
GetInterpartData()Returns: a tuple Return type: A tuple consisting of (interpartOption, parentOption). interpartOption is a bool. parentOption is a NXOpen.LoadOptionsParent.New in version NX3.0.0.
License requirements: None.
GetSearchDirectories¶
-
LoadOptions.GetSearchDirectories¶ Returns which search directories are to appear in the list.
Signature
GetSearchDirectories()Returns: a tuple Return type: A tuple consisting of (searchDirectories, searchSubDirs) searchDirectories is a list of str. True indicates that sub-directories will be searched as wellsearchSubDirs is a list of bool. New in version NX3.0.0.
License requirements: None.
Restore¶
-
LoadOptions.Restore¶ Changes the load options settings to what they are in the specified file
Signature
Restore(optionsFile)Parameters: optionsFile (str) – Name of file to restore from. If this is Nothing, then the default load options file name will be used. New in version NX3.0.0.
License requirements: None.
Save¶
-
LoadOptions.Save¶ Saves the current load options settings in a system file
Signature
Save(optionsFile)Parameters: optionsFile (str) – Name of file to save to. If this is Nothing, then the default load options file name will be used. New in version NX3.0.0.
License requirements: None.
SetBookmarkComponentsToLoad¶
-
LoadOptions.SetBookmarkComponentsToLoad¶ Signature
SetBookmarkComponentsToLoad(restoreAnt, restoreFullyLoadedStatus, componentsLoadOption)Parameters: - restoreAnt (bool) – whether or not to restore the state of assembly navigator
- restoreFullyLoadedStatus (bool) – whether or not to restore a part’s full “loadness” state
- componentsLoadOption (
NXOpen.LoadOptionsBookmarkComponents) – what components to load
New in version NX6.0.0.
License requirements: None.
SetDefaultReferenceSets¶
-
LoadOptions.SetDefaultReferenceSets¶ Sets the list of reference sets to be looked for, in order, when an assembly is loaded.
The default reference set list will always contain the four canned default reference sets: “As Saved”, “Use Model”, “Entire Part”, and “Empty”. These cannot be removed, but their order can be changed.
Signature
SetDefaultReferenceSets(referenceSets)Parameters: referenceSets (list of str) – New in version NX3.0.0.
License requirements: None.
SetInterpartData¶
-
LoadOptions.SetInterpartData¶ Sets the interpart data option which, when turned on, loads parts that are mated or contain interpart expressions, as well as those with WAVE data.
This method also lets you specify how unloaded parents should be loaded when interpart data loading is turned on.
Signature
SetInterpartData(interpartOption, parentOption)Parameters: - interpartOption (bool) – whether or not to allow interpart loading
- parentOption (
NXOpen.LoadOptionsParent) – how to load unloaded parents
New in version NX3.0.0.
License requirements: None.
SetSearchDirectories¶
-
LoadOptions.SetSearchDirectories¶ Set which search directories are to appear in the list.
Signature
SetSearchDirectories(searchDirectories, searchSubDirs)Parameters: - searchDirectories (list of str) – True indicates that sub-directories should be searched as well
- searchSubDirs (list of bool) –
New in version NX3.0.0.
License requirements: None.