NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::LoadOptions Class Reference

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

Public Types

enum  BookmarkComponents { BookmarkComponentsNoChange, BookmarkComponentsLoadVisible, BookmarkComponentsLoadLoaded, BookmarkComponentsLoadLoadedAndNonDisplayed }
 指定书签恢复时加载和可视化的组件的选项.  More...
 
enum  BookmarkRefsets { BookmarkRefsetsImportData, BookmarkRefsetsImportAndOptimizeLoad, BookmarkRefsetsDontImport }
 选项指定是否应该恢复书签中的引用集数据,并且应该只从选定的引用集合中加载拓扑来优化加载.  More...
 
enum  LoadComponents {
  LoadComponentsAll, LoadComponentsNone, LoadComponentsLastSet, LoadComponentsLastFilter,
  LoadComponentsSpecifyFilter
}
 指定在部分打开期间加载哪些组件部件的选项
Created in NX3.0.0. More...
 
enum  LoadMethod { LoadMethodAsSaved, LoadMethodFromDirectory, LoadMethodSearchDirectories }
 Options 用于指定如何加载组件部件
Created in NX3.0.0. More...
 
enum  ManagedModeLoadMethod { ManagedModeLoadMethodByRevisionRule = 1, ManagedModeLoadMethodAsSaved }
 Options 用于指定如何在托管模式中配置程序集结构 .  More...
 
enum  Parent { ParentPartial, ParentImmediate, ParentAll }
 Options 允许您指定如何卸载父项应加载时零件间的数据加载是打开的
Created in NX3.0.0. More...
 
enum  UpdateSubsetOnLoad { UpdateSubsetOnLoadNone, UpdateSubsetOnLoadReplayRecipe }
 Options 用于指定要进行加载时什么类型的子集的更新
Created in NX8.5.0. More...
 

Public Member Functions

bool AbortOnFailure ()
 返回一个选项,该选项指定系统如果找不到组件部分文件,应该采取什么操作
Created in NX3.0.0.
 
bool AllowSubstitution ()
 Returns the allow substition option.
 
NXOpen::LoadOptions::BookmarkRefsets BookmarkRefsetLoadBehavior ()
 返回指定的选项导入和加载组件的引用集打开书签. 
 
NXOpen::LoadOptions::LoadMethod ComponentLoadMethod ()
 返回一个选项,指示使用什么方法确定在哪里找到要加载的组件部分
Created in NX3.0.0.
 
NXOpen::LoadOptions::LoadComponents ComponentsToLoad ()
 返回指示部件在部分打开时加载的选项. 
 
bool GenerateMissingPartFamilyMembers ()
 返回控制是否在加载父程序集时自动重新生成缺失的部分家庭成员的选项
Created in NX3.0.0.
 
void GetBookmarkComponentsToLoad (bool *restoreAnt, NXOpen::LoadOptions::BookmarkComponents *componentsLoadOption)
 当加载标记时,组件的选项可以加载和可视化. 
 
std::vector< NXStringGetDefaultReferenceSets ()
 返回在加载程序集时要查找的引用集列表. 
 
void GetInterpartData (bool *interpartOption, NXOpen::LoadOptions::Parent *parentOption)
 返回interpart数据选项和父选项
Created in NX3.0.0.
 
void GetSearchDirectories (std::vector< NXString > &searchDirectories, std::vector< bool > &searchSubDirs)
 返回哪些搜索目录将出现在列表中. 
 
bool LoadLatest ()
 返回指定系统是否根据版本规则搜索最新组件的选项,或寻找精确匹配的选项. 
 
NXOpen::LoadOptions::ManagedModeLoadMethod ManagedModeComponentLoadMethod ()
 返回选项,该选项指示用于确定如何在托管模式下配置组装结构的方法
Created in NX8.5.0.
 
NXOpen::LoadOptions::UpdateSubsetOnLoad OptionUpdateSubsetOnLoad ()
 返回在加载期间控制子集更新的选项
Created in NX8.5.0.
 
bool ReferenceSetOverride ()
 返回一个选项,该选项指定默认引用集列表是否应该应用于组件树的所有组件. 
 
void Restore (const NXString &optionsFile)
 将加载选项设置更改为指定文件中的选项
Created in NX3.0.0.
 
void Restore (const char *optionsFile)
 将加载选项设置更改为指定文件中的选项
Created in NX3.0.0.
 
void Save (const NXString &optionsFile)
 
将当前加载选项设置保存在系统文件中


Created in NX3.0.0.

 
void Save (const char *optionsFile)
 
将当前加载选项设置保存在系统文件中


Created in NX3.0.0.

 
void SetAbortOnFailure (bool option)
 设置选项,该选项指定如果系统无法找到组件部分文件,系统应该采取什么操作
Created in NX3.0.0.
 
void SetAllowSubstitution (bool option)
 集合的替代选项ALLOW  . 
 
void SetBookmarkComponentsToLoad (bool restoreAnt, bool restoreFullyLoadedStatus, NXOpen::LoadOptions::BookmarkComponents componentsLoadOption)
 
Created in NX6.0.0.
 
void SetBookmarkRefsetLoadBehavior (NXOpen::LoadOptions::BookmarkRefsets refsetLoadOption)
 设置在打开标记时指定组件引用集的导入和加载的选项。. 
 
void SetComponentLoadMethod (NXOpen::LoadOptions::LoadMethod option)
 设置选项,指示使用什么方法确定在何处找到要加载的组件部分
Created in NX3.0.0.
 
void SetComponentsToLoad (NXOpen::LoadOptions::LoadComponents option)
 设置选项,指示在部分打开期间加载哪些组件部分. 
 
void SetDefaultReferenceSets (std::vector< NXString > &referenceSets)
 设置在加载程序集时要查找的参考集列表. 
 
void SetGenerateMissingPartFamilyMembers (bool option)
 设置一个选项,该选项控制在加载父程序集时是否自动重新生成丢失的部分家庭成员
Created in NX3.0.0.
 
void SetInterpartData (bool interpartOption, NXOpen::LoadOptions::Parent parentOption)
 设置interpart数据选项,当打开时,将加载已匹配的或包含interpart表达式的部分,以及具有WAVE数据的部分。

 
void SetLoadLatest (bool option)
 设置指定系统是否根据版本规则搜索最新组件的选项,或查找精确匹配的选项. 
 
void SetManagedModeComponentLoadMethod (NXOpen::LoadOptions::ManagedModeLoadMethod option)
 设置选项,指示使用什么方法来确定如何在托管模式下配置组装结构
Created in NX8.5.0.
 
void SetOptionUpdateSubsetOnLoad (NXOpen::LoadOptions::UpdateSubsetOnLoad option)
 设置在加载期间控制子集更新的选项
Created in NX8.5.0.
 
void SetReferenceSetOverride (bool option)
 设置一个选项,该选项指定默认引用集列表是否应该应用于组件树的所有组件。 . 
 
void SetSearchDirectories (std::vector< NXString > &searchDirectories, const std::vector< bool > &searchSubDirs)
 设置哪些搜索目录将出现在列表中. 
 
void SetUseLightweightRepresentations (bool option)
 设置一个选项,该控件控制组件是否以轻量级或精确表示形式显示。. 
 
void SetUsePartialLoading (bool option)
 设置控制组件部分加载的选项. 
 
tag_t Tag () const
 Returns the tag of this object.
 
bool UseLightweightRepresentations ()
 返回一个选项,该控件控制组件是否以轻量级或精确表示形式显示。. 
 
bool UsePartialLoading ()
 返回控制组件是否设置的是部分加载. 
 

Detailed Description

Contains accessor methods for all the part load options.


To obtain an instance of this class, refer to PartCollection

Created in NX3.0.0.

Member Enumeration Documentation

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

    <br> 
   <b>Note:</b> 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.
    <br> 


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.

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.

    <br> 
   <b>Note:</b> 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.
    <br>                 


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.

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

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

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

Enumerator:
ManagedModeLoadMethodAsSaved 

use assembly structure in the part file for load

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.

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 LoadOptions::LoadComponentsLastFilter or 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
restoreAntwhether to restore ANT's state
componentsLoadOptionwhat 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 three canned default reference sets: "As Saved", "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
interpartOptioninterpart option
parentOptionparent 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
searchDirectoriesTrue indicates that sub-directories will be searched as well
searchSubDirssearch 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

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
optionsFileName of file to restore from. If this is Nothing, then the default load options file name will be used.
NOTE: The full Unicode character set is not supported for this parameter.
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
optionsFileName of file to restore from. If this is Nothing, then the default load options file name will be used.
NOTE: The full Unicode character set is not supported for this parameter.
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
optionsFileName of file to save to. If this is Nothing, then the default load options file name will be used.
NOTE: The full Unicode character set is not supported for this parameter.
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
optionsFileName of file to save to. If this is Nothing, then the default load options file name will be used.
NOTE: The full Unicode character set is not supported for this parameter.
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
optionoption
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
optionoption
void NXOpen::LoadOptions::SetBookmarkComponentsToLoad ( bool  restoreAnt,
bool  restoreFullyLoadedStatus,
NXOpen::LoadOptions::BookmarkComponents  componentsLoadOption 
)


Created in NX6.0.0.



License requirements : None

Parameters
restoreAntwhether or not to restore the state of assembly navigator
restoreFullyLoadedStatuswhether or not to restore a part's full "loadness" state
componentsLoadOptionwhat 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
refsetLoadOptionwhat 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
optionoption
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 LoadOptions::LoadComponentsLastFilter or 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
optionoption
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 three canned default reference sets: "As Saved", "Entire Part", and "Empty". These cannot be removed, but their order can be changed.
Created in NX3.0.0.

License requirements : None

Parameters
referenceSets
NOTE: The full Unicode character set is not supported for this parameter.
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
optionoption
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
interpartOptionwhether or not to allow interpart loading
parentOptionhow 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
optionoption
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
optionoption
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
optionoption
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
optionoption
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
searchDirectoriesTrue indicates that sub-directories should be searched as well
NOTE: The full Unicode character set is not supported for this parameter.
searchSubDirssearch 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
optionoption
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
optionoption
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:
Copyright 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.