public interface LoadOptions extends Remote
PartCollection
Modifier and Type | Interface and Description |
---|---|
static class |
LoadOptions.BookmarkComponents
The options to specify what components to load and visualize when loading bookmarks.
|
static class |
LoadOptions.BookmarkComponentsToLoadData
This class holds the data returned from
getBookmarkComponentsToLoad() |
static class |
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.
|
static class |
LoadOptions.InterpartData
This class holds the data returned from
getInterpartData() |
static class |
LoadOptions.LoadComponents
Options for specifying what component parts to load during part open .
|
static class |
LoadOptions.LoadMethod
Options for specifying how to load component parts .
|
static class |
LoadOptions.ManagedModeLoadMethod
Options for specifying how to configure assembly structure in managed mode
|
static class |
LoadOptions.Parent
Options to allow you to specify how unloaded parents should be loaded
when interpart data loading is turned on .
|
static class |
LoadOptions.SearchDirectoriesData
This class holds the data returned from
getSearchDirectories() |
static class |
LoadOptions.UpdateSubsetOnLoad
Options for specifying what type of subset updation to be carried out while loading .
|
Modifier and Type | Method and Description |
---|---|
boolean |
abortOnFailure()
Returns the option that specifies what action the system should take if
it can't find a component part file
License requirements: None. |
boolean |
allowSubstitution()
Returns the allow substition option.
|
LoadOptions.BookmarkRefsets |
bookmarkRefsetLoadBehavior()
Returns the options that specify import and loading of components' reference sets when opening bookmarks.
|
LoadOptions.LoadMethod |
componentLoadMethod()
Returns the option indicating what method to use to determine where to
find component parts to load
License requirements: None. |
LoadOptions.LoadComponents |
componentsToLoad()
Returns the option indicating what component parts to load during part open.
|
boolean |
generateMissingPartFamilyMembers()
Returns the option that controls whether to automatically regenerate missing part
family members when it loads the parent assembly
License requirements: None. |
LoadOptions.BookmarkComponentsToLoadData |
getBookmarkComponentsToLoad()
The options for component parts to load and visualize when a bookmark is loaded.
|
String[] |
getDefaultReferenceSets()
Returns the list of reference sets to be looked
for, in order, when an assembly is loaded.
|
LoadOptions.InterpartData |
getInterpartData()
Returns the interpart data option and the parent option
License requirements: None. |
LoadOptions.SearchDirectoriesData |
getSearchDirectories()
Returns which search directories are to appear in the list.
|
boolean |
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.
|
LoadOptions.ManagedModeLoadMethod |
managedModeComponentLoadMethod()
Returns the option indicating what method to use to determine how to configure assembly structure
in managed mode
License requirements: None. |
LoadOptions.UpdateSubsetOnLoad |
optionUpdateSubsetOnLoad()
Returns the option that controls the subset updates during load
License requirements: None. |
boolean |
referenceSetOverride()
Returns the option that specifies if the default reference set list should be
applied to components all the way down an assembly tree.
|
void |
restore(String optionsFile)
Changes the load options settings to what they are in the specified file
License requirements: None. |
void |
save(String optionsFile)
Saves the current load options settings in a system file
License requirements: None. |
void |
setAbortOnFailure(boolean option)
Sets the option that specifies what action the system should take if
it can't find a component part file
License requirements: None. |
void |
setAllowSubstitution(boolean option)
Sets the allow substition option.
|
void |
setBookmarkComponentsToLoad(boolean restoreAnt,
boolean restoreFullyLoadedStatus,
LoadOptions.BookmarkComponents componentsLoadOption)
License requirements: None. |
void |
setBookmarkRefsetLoadBehavior(LoadOptions.BookmarkRefsets refsetLoadOption)
Sets the options that specify import and loading of components' reference sets when opening bookmarks.
|
void |
setComponentLoadMethod(LoadOptions.LoadMethod option)
Sets the option indicating what method to use to determine where to
find component parts to load
License requirements: None. |
void |
setComponentsToLoad(LoadOptions.LoadComponents option)
Sets the option indicating what component parts to load during part open.
|
void |
setDefaultReferenceSets(String[] referenceSets)
Sets the list of reference sets to be looked
for, in order, when an assembly is loaded.
|
void |
setGenerateMissingPartFamilyMembers(boolean option)
Sets the option that controls whether to automatically regenerate missing part
family members when it loads the parent assembly
License requirements: None. |
void |
setInterpartData(boolean interpartOption,
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.
|
void |
setLoadLatest(boolean 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.
|
void |
setManagedModeComponentLoadMethod(LoadOptions.ManagedModeLoadMethod option)
Sets the option indicating what method to use to determine how to configure assembly structure
in managed mode
License requirements: None. |
void |
setOptionUpdateSubsetOnLoad(LoadOptions.UpdateSubsetOnLoad option)
Sets the option that controls the subset updates during load
License requirements: None. |
void |
setReferenceSetOverride(boolean option)
Sets the option that specifies if the default reference set list should be
applied to components all the way down an assembly tree.
|
void |
setSearchDirectories(String[] searchDirectories,
boolean[] searchSubDirs)
Set which search directories are to appear in the list.
|
void |
setUseLightweightRepresentations(boolean option)
Sets the option that controls if components are displayed with a lightweight
or exact representation.
|
void |
setUsePartialLoading(boolean option)
Sets the option that controls the partial loading of components.
|
boolean |
useLightweightRepresentations()
Returns the option that controls if components are displayed with a lightweight
or exact representation.
|
boolean |
usePartialLoading()
Returns the option that controls the partial loading of components.
|
void setComponentLoadMethod(LoadOptions.LoadMethod option) throws NXException, RemoteException
option
- NXException
RemoteException
LoadOptions.LoadMethod componentLoadMethod() throws NXException, RemoteException
NXException
RemoteException
void setManagedModeComponentLoadMethod(LoadOptions.ManagedModeLoadMethod option) throws NXException, RemoteException
option
- NXException
RemoteException
LoadOptions.ManagedModeLoadMethod managedModeComponentLoadMethod() throws NXException, RemoteException
NXException
RemoteException
void setComponentsToLoad(LoadOptions.LoadComponents option) throws NXException, RemoteException
LoadOptions.LoadComponents.LAST_FILTER
or
LoadOptions.LoadComponents.SPECIFY_FILTER
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.
option
- NXException
RemoteException
LoadOptions.LoadComponents componentsToLoad() throws NXException, RemoteException
LoadOptions.LoadComponents.LAST_FILTER
or
LoadOptions.LoadComponents.SPECIFY_FILTER
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.
NXException
RemoteException
void setUsePartialLoading(boolean option) throws NXException, RemoteException
option
- NXException
RemoteException
boolean usePartialLoading() throws NXException, RemoteException
NXException
RemoteException
void setUseLightweightRepresentations(boolean option) throws NXException, RemoteException
option
- NXException
RemoteException
boolean useLightweightRepresentations() throws NXException, RemoteException
NXException
RemoteException
void setGenerateMissingPartFamilyMembers(boolean option) throws NXException, RemoteException
option
- NXException
RemoteException
boolean generateMissingPartFamilyMembers() throws NXException, RemoteException
NXException
RemoteException
void setInterpartData(boolean interpartOption, LoadOptions.Parent parentOption) throws NXException, RemoteException
interpartOption
- whether or not to allow interpart loadingparentOption
- how to load unloaded parentsNXException
RemoteException
LoadOptions.InterpartData getInterpartData() throws NXException, RemoteException
NXException
RemoteException
void setBookmarkComponentsToLoad(boolean restoreAnt, boolean restoreFullyLoadedStatus, LoadOptions.BookmarkComponents componentsLoadOption) throws NXException, RemoteException
restoreAnt
- whether or not to restore the state of assembly navigatorrestoreFullyLoadedStatus
- whether or not to restore a part's full "loadness" statecomponentsLoadOption
- what components to loadNXException
RemoteException
LoadOptions.BookmarkComponentsToLoadData getBookmarkComponentsToLoad() throws NXException, RemoteException
NXException
RemoteException
void setBookmarkRefsetLoadBehavior(LoadOptions.BookmarkRefsets refsetLoadOption) throws NXException, RemoteException
refsetLoadOption
- what to do with reference set dataNXException
RemoteException
LoadOptions.BookmarkRefsets bookmarkRefsetLoadBehavior() throws NXException, RemoteException
NXException
RemoteException
void setAbortOnFailure(boolean option) throws NXException, RemoteException
option
- NXException
RemoteException
boolean abortOnFailure() throws NXException, RemoteException
NXException
RemoteException
void setAllowSubstitution(boolean option) throws NXException, RemoteException
option
- NXException
RemoteException
boolean allowSubstitution() throws NXException, RemoteException
NXException
RemoteException
void setLoadLatest(boolean option) throws NXException, RemoteException
option
- NXException
RemoteException
boolean loadLatest() throws NXException, RemoteException
NXException
RemoteException
void setSearchDirectories(String[] searchDirectories, boolean[] searchSubDirs) throws NXException, RemoteException
searchDirectories
- True indicates that sub-directories should be searched as well searchSubDirs
- NXException
RemoteException
LoadOptions.SearchDirectoriesData getSearchDirectories() throws NXException, RemoteException
NXException
RemoteException
void setDefaultReferenceSets(String[] referenceSets) throws NXException, RemoteException
referenceSets
- NXException
RemoteException
String[] getDefaultReferenceSets() throws NXException, RemoteException
NXException
RemoteException
void setReferenceSetOverride(boolean option) throws NXException, RemoteException
option
- NXException
RemoteException
boolean referenceSetOverride() throws NXException, RemoteException
NXException
RemoteException
void save(String optionsFile) throws NXException, RemoteException
optionsFile
- Name of file to save to. If this is Nothing,
then the default load options file name will be used. NXException
RemoteException
void restore(String optionsFile) throws NXException, RemoteException
optionsFile
- Name of file to restore from. If this is
Nothing, then the default load options file name will be used. NXException
RemoteException
void setOptionUpdateSubsetOnLoad(LoadOptions.UpdateSubsetOnLoad option) throws NXException, RemoteException
option
- NXException
RemoteException
LoadOptions.UpdateSubsetOnLoad optionUpdateSubsetOnLoad() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.