Contains accessor methods for all the part load options. More...

Public Types
enum	BookmarkComponents { BookmarkComponentsNoChange, BookmarkComponentsLoadVisible, BookmarkComponentsLoadLoaded, BookmarkComponentsLoadLoadedAndNonDisplayed }
	The options to specify what components to load and visualize when loading bookmarks. More...

enum	BookmarkRefsets { BookmarkRefsetsImportData, BookmarkRefsetsImportAndOptimizeLoad, BookmarkRefsetsDontImport }
	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. More...

enum	LoadComponents { LoadComponentsAll, LoadComponentsNone, LoadComponentsLastSet, LoadComponentsLastFilter, LoadComponentsSpecifyFilter }
	Options for specifying what component parts to load during part open Created in NX3.0.0. More...

enum	LoadMethod { LoadMethodAsSaved, LoadMethodFromDirectory, LoadMethodSearchDirectories }
	Options for specifying how to load component parts Created in NX3.0.0. More...

enum	LoadOption { LoadOptionFullyLoad, LoadOptionPartiallyLoad, LoadOptionFullyLoadLightweightDisplay, LoadOptionPartiallyLoadLightweightDisplay, LoadOptionMinimalLoadVisualize }
	Option to control how much data is loaded from parts. More...

enum	ManagedModeLoadMethod { ManagedModeLoadMethodByRevisionRule = 1, ManagedModeLoadMethodAsSaved }
	Options for specifying how to configure assembly structure in managed mode. More...

enum	Parent { ParentPartial, ParentImmediate, ParentAll }
	Options to allow you to specify how unloaded parents should be loaded when interpart data loading is turned on Created in NX3.0.0. More...

enum	UpdateSubsetOnLoad { UpdateSubsetOnLoadNone, UpdateSubsetOnLoadReplayRecipe }
	Options for specifying what type of subset updation to be carried out while loading Created in NX8.5.0. More...

Public Member Functions
bool	AbortOnFailure ()
	Returns the option that specifies what action the system should take if it can't find a component part file Created in NX3.0.0. More...

bool	AllowSubstitution ()
	Returns the allow substition option. More...

NXOpen::LoadOptions::BookmarkRefsets	BookmarkRefsetLoadBehavior ()
	Returns the options that specify import and loading of components' reference sets when opening bookmarks. More...

NXOpen::LoadOptions::LoadMethod	ComponentLoadMethod ()
	Returns the option indicating what method to use to determine where to find component parts to load Created in NX3.0.0. More...

NXOpen::LoadOptions::LoadComponents	ComponentsToLoad ()
	Returns the option indicating what component parts to load during part open. More...

bool	GenerateMissingPartFamilyMembers ()
	Returns the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly Created in NX3.0.0. More...

void	GetBookmarkComponentsToLoad (bool restoreAnt, NXOpen::LoadOptions::BookmarkComponents componentsLoadOption)
	The options for component parts to load and visualize when a bookmark is loaded. More...

std::vector< NXString >	GetDefaultReferenceSets ()
	Returns the list of reference sets to be looked for, in order, when an assembly is loaded. More...

void	GetInterpartData (bool interpartOption, NXOpen::LoadOptions::Parent parentOption)
	Returns the interpart data option and the parent option Created in NX3.0.0. More...

void	GetSearchDirectories (std::vector< NXString > &searchDirectories, std::vector< bool > &searchSubDirs)
	Returns which search directories are to appear in the list. More...

bool	LoadLatest ()
	Returns the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match. More...

NXOpen::LoadOptions::ManagedModeLoadMethod	ManagedModeComponentLoadMethod ()
	Returns the option indicating what method to use to determine how to configure assembly structure in managed mode Created in NX8.5.0. More...

NXOpen::LoadOptions::UpdateSubsetOnLoad	OptionUpdateSubsetOnLoad ()
	Returns the option that controls the subset updates during load Created in NX8.5.0. More...

NXOpen::LoadOptions::LoadOption	PartLoadOption ()
	Returns the option that controls how the part is being loaded Created in NX12.0.0. More...

bool	ReferenceSetOverride ()
	Returns the option that specifies if the default reference set list should be applied to components all the way down an assembly tree. More...

void	Restore (const NXString &optionsFile)
	Changes the load options settings to what they are in the specified file Created in NX3.0.0. More...

void	Restore (const char *optionsFile)
	Changes the load options settings to what they are in the specified file Created in NX3.0.0. More...

void	Save (const NXString &optionsFile)
	Saves the current load options settings in a system file Created in NX3.0.0. More...

void	Save (const char *optionsFile)
	Saves the current load options settings in a system file Created in NX3.0.0. More...

void	SetAbortOnFailure (bool option)
	Sets the option that specifies what action the system should take if it can't find a component part file Created in NX3.0.0. More...

void	SetAllowSubstitution (bool option)
	Sets the allow substition option. More...

void	SetBookmarkComponentsToLoad (bool restoreAnt, bool restoreFullyLoadedStatus, NXOpen::LoadOptions::BookmarkComponents componentsLoadOption)
	Created in NX6.0.0. More...

void	SetBookmarkRefsetLoadBehavior (NXOpen::LoadOptions::BookmarkRefsets refsetLoadOption)
	Sets the options that specify import and loading of components' reference sets when opening bookmarks. More...

void	SetComponentLoadMethod (NXOpen::LoadOptions::LoadMethod option)
	Sets the option indicating what method to use to determine where to find component parts to load Created in NX3.0.0. More...

void	SetComponentsToLoad (NXOpen::LoadOptions::LoadComponents option)
	Sets the option indicating what component parts to load during part open. More...

void	SetDefaultReferenceSets (std::vector< NXString > &referenceSets)
	Sets the list of reference sets to be looked for, in order, when an assembly is loaded. More...

void	SetGenerateMissingPartFamilyMembers (bool option)
	Sets the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly Created in NX3.0.0. More...

void	SetInterpartData (bool interpartOption, NXOpen::LoadOptions::Parent parentOption)
	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. More...

void	SetLoadLatest (bool option)
	Sets the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match. More...

void	SetManagedModeComponentLoadMethod (NXOpen::LoadOptions::ManagedModeLoadMethod option)
	Sets the option indicating what method to use to determine how to configure assembly structure in managed mode Created in NX8.5.0. More...

void	SetOptionUpdateSubsetOnLoad (NXOpen::LoadOptions::UpdateSubsetOnLoad option)
	Sets the option that controls the subset updates during load Created in NX8.5.0. More...

void	SetPartLoadOption (NXOpen::LoadOptions::LoadOption loadOption)
	Sets the option that controls how the part is being loaded Created in NX12.0.0. More...

void	SetReferenceSetOverride (bool option)
	Sets the option that specifies if the default reference set list should be applied to components all the way down an assembly tree. More...

void	SetSearchDirectories (std::vector< NXString > &searchDirectories, const std::vector< bool > &searchSubDirs)
	Set which search directories are to appear in the list. More...

void	SetUseLightweightRepresentations (bool option)
	Sets the option that controls if components are displayed with a lightweight or exact representation. More...

void	SetUsePartialLoading (bool option)
	Sets the option that controls the partial loading of components. More...

tag_t	Tag () const
	Returns the tag of this object. More...

bool	UseLightweightRepresentations ()
	Returns the option that controls if components are displayed with a lightweight or exact representation. More...

bool	UsePartialLoading ()
	Returns the option that controls the partial loading of components. More...

Detailed Description

Contains accessor methods for all the part load options.

To obtain an instance of this class, refer to NXOpen::PartCollection

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::LoadOptions::BookmarkComponents

The options to specify what components to load and visualize when loading bookmarks.

Note: The visiblity and fully loaded state will only be restored for components that are part of the bookmark's product assembly. The bookmark's product assembly is the one that was the displayed part at the time the bookmark was saved.

Created in NX6.0.0.

Enumerator
BookmarkComponentsNoChange	This option has no effect. Using this value will leave the current setting active (not exposed in UI)
BookmarkComponentsLoadVisible	Load and show only what was shown on the bookmark's save. Don't load invisible components.
BookmarkComponentsLoadLoaded	Load and show only what was loaded on the bookmark's save Load invisible components and keep them invisible.
BookmarkComponentsLoadLoadedAndNonDisplayed	Load and show only what was loaded on the bookmark's save, including non-display parts. Load invisible components and keep them invisible. All non-display parts are invisible.

enum NXOpen::LoadOptions::BookmarkRefsets

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.

Note: The reference set data will only be restored for components that are part of the bookmark's product assembly. The bookmark's product assembly is the one that was the displayed part at the time the bookmark was saved.

Created in NX6.0.0.

Enumerator
BookmarkRefsetsImportData	Import reference set data.
BookmarkRefsetsImportAndOptimizeLoad	Import reference set data and use it to optimize load.
BookmarkRefsetsDontImport	Do nothing with the bookmark reference set data.

enum NXOpen::LoadOptions::LoadComponents

Options for specifying what component parts to load during part open
Created in NX3.0.0.

Enumerator
LoadComponentsAll	load all components
LoadComponentsNone	load none of the components
LoadComponentsLastSet	use same set of components as when the assembly was last saved
LoadComponentsLastFilter	use same filter used to last load the assembly
LoadComponentsSpecifyFilter	display list of pre-defined component groups to select from

enum NXOpen::LoadOptions::LoadMethod

Options for specifying how to load component parts
Created in NX3.0.0.

Enumerator
LoadMethodAsSaved	use same directory in which they were saved
LoadMethodFromDirectory	use same directory as the parent assembly
LoadMethodSearchDirectories	use a list of search directories

enum NXOpen::LoadOptions::LoadOption

Option to control how much data is loaded from parts.

The first four settings are equivalent to the four possible combinations of the properties NXOpen::LoadOptions::UsePartialLoading and NXOpen::LoadOptions::UseLightweightRepresentations . The final setting is reserved for future use.

Created in NX12.0.0.

Enumerator
LoadOptionFullyLoad	partial load : off, use lightweight : off
LoadOptionPartiallyLoad	partial load : on, use lightweight : off
LoadOptionFullyLoadLightweightDisplay	partial load : off, use lightweight : on
LoadOptionPartiallyLoadLightweightDisplay	partial load : on, use lightweight : on
LoadOptionMinimalLoadVisualize	reserved for future use

enum NXOpen::LoadOptions::ManagedModeLoadMethod

Options for specifying how to configure assembly structure in managed mode.

Enumerator
ManagedModeLoadMethodByRevisionRule	use the assembly structure configured by revision rule for load
ManagedModeLoadMethodAsSaved	use assembly structure in the part file for load

enum NXOpen::LoadOptions::Parent

Options to allow you to specify how unloaded parents should be loaded when interpart data loading is turned on
Created in NX3.0.0.

Enumerator
ParentPartial	Do not load any unloaded parents, but fully load partially loaded parts with parent geometry.
ParentImmediate	Fully load parts that satisfy one level of parent references as well as any partially loaded parts with parent geometry.
ParentAll	Recursively fully load all parts with parent geometry linked to geometry in the parts selected for loading.

enum NXOpen::LoadOptions::UpdateSubsetOnLoad

Options for specifying what type of subset updation to be carried out while loading
Created in NX8.5.0.

Enumerator
UpdateSubsetOnLoadNone	replay recipe
UpdateSubsetOnLoadReplayRecipe	do not update

Member Function Documentation

bool NXOpen::LoadOptions::AbortOnFailure ( )

Returns the option that specifies what action the system should take if it can't find a component part file
Created in NX3.0.0.

License requirements : None

bool NXOpen::LoadOptions::AllowSubstitution ( )

Returns 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.
Created in NX3.0.0.

License requirements : None

NXOpen::LoadOptions::BookmarkRefsets NXOpen::LoadOptions::BookmarkRefsetLoadBehavior ( )

Returns the options that specify import and loading of components' reference sets when opening bookmarks.

Created in NX6.0.0.

License requirements : None

NXOpen::LoadOptions::LoadMethod NXOpen::LoadOptions::ComponentLoadMethod ( )

Returns the option indicating what method to use to determine where to find component parts to load
Created in NX3.0.0.

License requirements : None

NXOpen::LoadOptions::LoadComponents NXOpen::LoadOptions::ComponentsToLoad ( )

Returns the option indicating what component parts to load during part open.

Note that this property cannot be set to NXOpen::LoadOptions::LoadComponentsLastFilter or NXOpen::LoadOptions::LoadComponentsSpecifyFilter without 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.
Created in NX3.0.0.

License requirements : None

bool NXOpen::LoadOptions::GenerateMissingPartFamilyMembers ( )

Returns the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly
Created in NX3.0.0.

License requirements : None

void NXOpen::LoadOptions::GetBookmarkComponentsToLoad	(	bool *	restoreAnt,
		NXOpen::LoadOptions::BookmarkComponents *	componentsLoadOption
	)

The options for component parts to load and visualize when a bookmark is loaded.

Created in NX6.0.0.

License requirements : None

Parameters

restoreAnt	whether to restore ANT's state
componentsLoadOption	what components to load

std::vector<NXString> NXOpen::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".

Returns: Created in NX3.0.0.

License requirements : None

void NXOpen::LoadOptions::GetInterpartData	(	bool *	interpartOption,
		NXOpen::LoadOptions::Parent *	parentOption
	)

Returns the interpart data option and the parent option
Created in NX3.0.0.

License requirements : None

Parameters

interpartOption	interpart option
parentOption	parent option

void NXOpen::LoadOptions::GetSearchDirectories	(	std::vector< NXString > &	searchDirectories,
		std::vector< bool > &	searchSubDirs
	)

Returns which search directories are to appear in the list.

Created in NX3.0.0.

License requirements : None

Parameters

searchDirectories	True indicates that sub-directories will be searched as well
searchSubDirs	search sub dirs

bool NXOpen::LoadOptions::LoadLatest ( )

Returns the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match.

Created in NX3.0.0.

License requirements : None

NXOpen::LoadOptions::ManagedModeLoadMethod NXOpen::LoadOptions::ManagedModeComponentLoadMethod ( )

Returns the option indicating what method to use to determine how to configure assembly structure in managed mode
Created in NX8.5.0.

License requirements : None

NXOpen::LoadOptions::UpdateSubsetOnLoad NXOpen::LoadOptions::OptionUpdateSubsetOnLoad ( )

Returns the option that controls the subset updates during load
Created in NX8.5.0.

License requirements : None

NXOpen::LoadOptions::LoadOption NXOpen::LoadOptions::PartLoadOption ( )

Returns the option that controls how the part is being loaded
Created in NX12.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

bool NXOpen::LoadOptions::ReferenceSetOverride ( )

Returns 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.
Created in NX3.0.0.

License requirements : None

void NXOpen::LoadOptions::Restore ( const NXString & optionsFile )

Changes the load options settings to what they are in the specified file
Created in NX3.0.0.

License requirements : None

Parameters

optionsFile Name of file to restore from. If this is Nothing, then the default load options file name will be used.

void NXOpen::LoadOptions::Restore ( const char * optionsFile )

Changes the load options settings to what they are in the specified file
Created in NX3.0.0.

License requirements : None

Parameters

optionsFile Name of file to restore from. If this is Nothing, then the default load options file name will be used.

void NXOpen::LoadOptions::Save ( const NXString & optionsFile )

Saves the current load options settings in a system file
Created in NX3.0.0.

License requirements : None

Parameters

optionsFile Name of file to save to. If this is Nothing, then the default load options file name will be used.

void NXOpen::LoadOptions::Save ( const char * optionsFile )

Saves the current load options settings in a system file
Created in NX3.0.0.

License requirements : None

Parameters

optionsFile Name of file to save to. If this is Nothing, then the default load options file name will be used.

void NXOpen::LoadOptions::SetAbortOnFailure ( bool option )

Sets the option that specifies what action the system should take if it can't find a component part file
Created in NX3.0.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetAllowSubstitution ( bool option )

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.
Created in NX3.0.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetBookmarkComponentsToLoad	(	bool	restoreAnt,
		bool	restoreFullyLoadedStatus,
		NXOpen::LoadOptions::BookmarkComponents	componentsLoadOption
	)

Created in NX6.0.0.

License requirements : None

Parameters

restoreAnt	whether or not to restore the state of assembly navigator
restoreFullyLoadedStatus	whether or not to restore a part's full "loadness" state
componentsLoadOption	what components to load

void NXOpen::LoadOptions::SetBookmarkRefsetLoadBehavior ( NXOpen::LoadOptions::BookmarkRefsets refsetLoadOption )

Sets the options that specify import and loading of components' reference sets when opening bookmarks.

Created in NX6.0.0.

License requirements : None

Parameters

refsetLoadOption what to do with reference set data

void NXOpen::LoadOptions::SetComponentLoadMethod ( NXOpen::LoadOptions::LoadMethod option )

Sets the option indicating what method to use to determine where to find component parts to load
Created in NX3.0.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetComponentsToLoad ( NXOpen::LoadOptions::LoadComponents option )

Sets the option indicating what component parts to load during part open.

Note that this property cannot be set to NXOpen::LoadOptions::LoadComponentsLastFilter or NXOpen::LoadOptions::LoadComponentsSpecifyFilter without 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.
Created in NX3.0.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetDefaultReferenceSets ( std::vector< NXString > & referenceSets )

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.
Created in NX3.0.0.

License requirements : None

Parameters

referenceSets reference sets

void NXOpen::LoadOptions::SetGenerateMissingPartFamilyMembers ( bool option )

Sets the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly
Created in NX3.0.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetInterpartData	(	bool	interpartOption,
		NXOpen::LoadOptions::Parent	parentOption
	)

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.
Created in NX3.0.0.

License requirements : None

Parameters

interpartOption	whether or not to allow interpart loading
parentOption	how to load unloaded parents

void NXOpen::LoadOptions::SetLoadLatest ( bool option )

Sets the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match.

Created in NX3.0.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetManagedModeComponentLoadMethod ( NXOpen::LoadOptions::ManagedModeLoadMethod option )

Sets the option indicating what method to use to determine how to configure assembly structure in managed mode
Created in NX8.5.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetOptionUpdateSubsetOnLoad ( NXOpen::LoadOptions::UpdateSubsetOnLoad option )

Sets the option that controls the subset updates during load
Created in NX8.5.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetPartLoadOption ( NXOpen::LoadOptions::LoadOption loadOption )

Sets the option that controls how the part is being loaded
Created in NX12.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

loadOption loadoption

void NXOpen::LoadOptions::SetReferenceSetOverride ( bool option )

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.
Created in NX3.0.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetSearchDirectories	(	std::vector< NXString > &	searchDirectories,
		const std::vector< bool > &	searchSubDirs
	)

Set which search directories are to appear in the list.

Created in NX3.0.0.

License requirements : None

Parameters

searchDirectories	True indicates that sub-directories should be searched as well
searchSubDirs	search sub dirs

void NXOpen::LoadOptions::SetUseLightweightRepresentations ( bool option )

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
Created in NX7.5.0.

License requirements : None

Parameters

option option

void NXOpen::LoadOptions::SetUsePartialLoading ( bool option )

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
Created in NX3.0.0.

License requirements : None

Parameters

option option

tag_t NXOpen::LoadOptions::Tag ( ) const

Returns the tag of this object.

bool NXOpen::LoadOptions::UseLightweightRepresentations ( )

Returns 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
Created in NX7.5.0.

License requirements : None

bool NXOpen::LoadOptions::UsePartialLoading ( )

Returns 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
Created in NX3.0.0.

License requirements : None

The documentation for this class was generated from the following file:

LoadOptions.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation