A SubsetBuilder is used to create or edit an NXOpen::Assemblies::Subset . More...
Public Member Functions | |
| bool | AddAllSubordinates () |
| Returns the value which determines whether the subset will include all the subordinates of reuse design elements. More... | |
| NXOpen::CollaborativeDesign * | CollaborativeDesign () |
| Returns the NXOpen::CollaborativeDesign of the subset. More... | |
| NXOpen::PDM::ConfigurationContextBuilder * | ConfigurationContext () |
| Returns the configuration context builder. More... | |
| NXOpen::Assemblies::FindInCollaborativeDesign * | Finder () |
| Returns the NXOpen::Assemblies::FindInCollaborativeDesign for use in the context determined by this builder. More... | |
| NXOpen::NXObject * | FindObject (const NXString &journalIdentifier) |
| Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
| NXOpen::NXObject * | FindObject (const char *journalIdentifier) |
| Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
| void | GenerateResults () |
| Generate the search results for the NXOpen::Assemblies::Subset according to the current NXOpen::Assemblies::SubsetRecipe . More... | |
| NXOpen::Assemblies::SubsetRecipe * | Recipe () |
| Returns the NXOpen::Assemblies::SubsetRecipe that contains the NXOpen::Assemblies::SearchTerm s used to generate the contents of the subset Created in NX8.5.0. More... | |
| NXOpen::Assemblies::SearchResultCollection * | SearchResults () |
| Returns the NXOpen::Assemblies::SearchResultCollection that contains current search results associated with this subset builder. More... | |
| void | SetAddAllSubordinates (bool addAllSubordinates) |
| Sets the value which determines whether the subset will include all the subordinates of reuse design elements. More... | |
| void | SetCollaborativeDesign (NXOpen::CollaborativeDesign *collaborativeDesign) |
| Sets the NXOpen::CollaborativeDesign of the subset. More... | |
| void | SetSubsetDescription (const NXString &description) |
| Sets the description of the NXOpen::Assemblies::Subset . More... | |
| void | SetSubsetDescription (const char *description) |
| Sets the description of the NXOpen::Assemblies::Subset . More... | |
| void | SetSubsetName (const NXString &name) |
| Sets the name of the NXOpen::Assemblies::Subset . More... | |
| void | SetSubsetName (const char *name) |
| Sets the name of the NXOpen::Assemblies::Subset . More... | |
| void | SetViewedPartitionScheme (NXOpen::Assemblies::PartitionScheme *partitionScheme) |
| Sets the viewed NXOpen::Assemblies::PartitionScheme of the subset. More... | |
| NXOpen::Assemblies::Subset * | Subset () |
| Returns the NXOpen::Assemblies::Subset that we are building. More... | |
| NXOpen::Assemblies::SubsetConfigurationBuilder * | SubsetConfiguration () |
| Returns the subset configuration. More... | |
| NXString | SubsetDescription () |
| Returns the description of the NXOpen::Assemblies::Subset . More... | |
| NXString | SubsetName () |
| Returns the name of the NXOpen::Assemblies::Subset . More... | |
| NXOpen::BasicEffectivityBuilder * | TargetEffectivity () |
| Returns the NXOpen::BasicEffectivityBuilder used to edit the target effectivity of the subset. More... | |
| NXOpen::PDM::EffectivityTableBuilder * | TargetEffectivityTable () |
| Returns the NXOpen::PDM::EffectivityTableBuilder used to edit the target effectivity of the subset. More... | |
| NXOpen::Assemblies::PartitionList * | TargetPartitionList () |
| Returns the default target NXOpen::Assemblies::Partition s for design elements created within the subset. More... | |
| NXOpen::Assemblies::PartitionScheme * | ViewedPartitionScheme () |
| Returns the viewed NXOpen::Assemblies::PartitionScheme of the subset. More... | |
| NXOpen::Assemblies::ComponentAssembly * | Workset () |
| Returns the NXOpen::Assemblies::ComponentAssembly within which we are building an NXOpen::Assemblies::Subset . More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
A SubsetBuilder is used to create or edit an NXOpen::Assemblies::Subset .
To create a new instance of this class, use NXOpen::Assemblies::SubsetCollection::CreateSubsetBuilder
Created in NX8.5.0.
Member Function Documentation
| bool NXOpen::Assemblies::SubsetBuilder::AddAllSubordinates | ( | ) |
Returns the value which determines whether the subset will include all the subordinates of reuse design elements.
Created in NX9.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::CollaborativeDesign* NXOpen::Assemblies::SubsetBuilder::CollaborativeDesign | ( | ) |
Returns the NXOpen::CollaborativeDesign of the subset.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::PDM::ConfigurationContextBuilder* NXOpen::Assemblies::SubsetBuilder::ConfigurationContext | ( | ) |
Returns the configuration context builder.
Created in NX9.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::Assemblies::FindInCollaborativeDesign* NXOpen::Assemblies::SubsetBuilder::Finder | ( | ) |
Returns the NXOpen::Assemblies::FindInCollaborativeDesign for use in the context determined by this builder.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::NXObject* NXOpen::Assemblies::SubsetBuilder::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the NXOpen::NXObject with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
- Returns
- Object found, or null if no such object exists
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
journalIdentifier Identifier of the NXOpen::NXObject to be found
| NXOpen::NXObject* NXOpen::Assemblies::SubsetBuilder::FindObject | ( | const char * | journalIdentifier | ) |
Finds the NXOpen::NXObject with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
- Returns
- Object found, or null if no such object exists
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
journalIdentifier Identifier of the NXOpen::NXObject to be found
| void NXOpen::Assemblies::SubsetBuilder::GenerateResults | ( | ) |
Generate the search results for the NXOpen::Assemblies::Subset according to the current NXOpen::Assemblies::SubsetRecipe .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::Assemblies::SubsetRecipe* NXOpen::Assemblies::SubsetBuilder::Recipe | ( | ) |
Returns the NXOpen::Assemblies::SubsetRecipe that contains the NXOpen::Assemblies::SearchTerm s used to generate the contents of the subset
Created in NX8.5.0.
| NXOpen::Assemblies::SearchResultCollection* NXOpen::Assemblies::SubsetBuilder::SearchResults | ( | ) |
Returns the NXOpen::Assemblies::SearchResultCollection that contains current search results associated with this subset builder.
SearchResults will be populated with the existing subset contents when the builder is created to edit a subset. These are replaced with results found by the last call to SubsetBuilder::GenerateResults after that method is first called. In addition, the last results from SubsetBuilder::Finder are included in this collection.
Created in NX8.5.0.
| void NXOpen::Assemblies::SubsetBuilder::SetAddAllSubordinates | ( | bool | addAllSubordinates | ) |
Sets the value which determines whether the subset will include all the subordinates of reuse design elements.
Created in NX9.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
addAllSubordinates addallsubordinates
| void NXOpen::Assemblies::SubsetBuilder::SetCollaborativeDesign | ( | NXOpen::CollaborativeDesign * | collaborativeDesign | ) |
Sets the NXOpen::CollaborativeDesign of the subset.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
collaborativeDesign collaborativedesign
| void NXOpen::Assemblies::SubsetBuilder::SetSubsetDescription | ( | const NXString & | description | ) |
Sets the description of the NXOpen::Assemblies::Subset .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
description description
| void NXOpen::Assemblies::SubsetBuilder::SetSubsetDescription | ( | const char * | description | ) |
Sets the description of the NXOpen::Assemblies::Subset .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
description description
| void NXOpen::Assemblies::SubsetBuilder::SetSubsetName | ( | const NXString & | name | ) |
Sets the name of the NXOpen::Assemblies::Subset .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
name name
| void NXOpen::Assemblies::SubsetBuilder::SetSubsetName | ( | const char * | name | ) |
Sets the name of the NXOpen::Assemblies::Subset .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
name name
| void NXOpen::Assemblies::SubsetBuilder::SetViewedPartitionScheme | ( | NXOpen::Assemblies::PartitionScheme * | partitionScheme | ) |
Sets the viewed NXOpen::Assemblies::PartitionScheme of the subset.
Created in NX9.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
partitionScheme partitionscheme
| NXOpen::Assemblies::Subset* NXOpen::Assemblies::SubsetBuilder::Subset | ( | ) |
Returns the NXOpen::Assemblies::Subset that we are building.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::Assemblies::SubsetConfigurationBuilder* NXOpen::Assemblies::SubsetBuilder::SubsetConfiguration | ( | ) |
Returns the subset configuration.
- Deprecated:
- Deprecated in NX9.0.0. Use NXOpen::Assemblies::SubsetBuilder::ConfigurationContext instead.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXString NXOpen::Assemblies::SubsetBuilder::SubsetDescription | ( | ) |
Returns the description of the NXOpen::Assemblies::Subset .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXString NXOpen::Assemblies::SubsetBuilder::SubsetName | ( | ) |
Returns the name of the NXOpen::Assemblies::Subset .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::BasicEffectivityBuilder* NXOpen::Assemblies::SubsetBuilder::TargetEffectivity | ( | ) |
Returns the NXOpen::BasicEffectivityBuilder used to edit the target effectivity of the subset.
- Deprecated:
- Deprecated in NX9.0.0. Use SubsetBuilder::TargetEffectivityTable instead.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::PDM::EffectivityTableBuilder* NXOpen::Assemblies::SubsetBuilder::TargetEffectivityTable | ( | ) |
Returns the NXOpen::PDM::EffectivityTableBuilder used to edit the target effectivity of the subset.
Created in NX9.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::Assemblies::PartitionList* NXOpen::Assemblies::SubsetBuilder::TargetPartitionList | ( | ) |
Returns the default target NXOpen::Assemblies::Partition s for design elements created within the subset.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::Assemblies::PartitionScheme* NXOpen::Assemblies::SubsetBuilder::ViewedPartitionScheme | ( | ) |
Returns the viewed NXOpen::Assemblies::PartitionScheme of the subset.
Created in NX9.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
| NXOpen::Assemblies::ComponentAssembly* NXOpen::Assemblies::SubsetBuilder::Workset | ( | ) |
Returns the NXOpen::Assemblies::ComponentAssembly within which we are building an NXOpen::Assemblies::Subset .
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
The documentation for this class was generated from the following file:
- Assemblies_SubsetBuilder.hxx