A subset recipe is used by a NXOpen::Assemblies::SubsetBuilder to collect NXOpen::Assemblies::SearchTerm s. More...
Classes | |
| class | iterator |
| Iterator for accessing the contents of the collection. More... | |
Detailed Description
A subset recipe is used by a NXOpen::Assemblies::SubsetBuilder to collect NXOpen::Assemblies::SearchTerm s.
The search terms specify the search that defines the contents of a NXOpen::Assemblies::Subset .
To obtain an instance of this class, refer to NXOpen::Assemblies::SubsetBuilder
Created in NX8.5.0.
Member Function Documentation
| void NXOpen::Assemblies::SubsetRecipe::AddSearchTermBuilder | ( | NXOpen::Assemblies::SearchTermBuilder * | searchTermBuilder | ) |
Add a NXOpen::Assemblies::SearchTermBuilder to the recipe.
When this search term builder is committed the search term will be added to the recipe at the end of the list of search terms.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
searchTermBuilder searchtermbuilder
| iterator NXOpen::Assemblies::SubsetRecipe::begin | ( | ) |
Returns an iterator addressing the first element.
| NXOpen::Assemblies::AttributeSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateAttributeSearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const NXString & | queryName, | ||
| std::vector< NXString > & | entries, | ||
| std::vector< NXString > & | values | ||
| ) |
Creates a NXOpen::Assemblies::AttributeSearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype queryName Name of the saved query upon which this search term is based entries search criteria entries values search criteria values
| NXOpen::Assemblies::AttributeSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateAttributeSearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const char * | queryName, | ||
| std::vector< NXString > & | entries, | ||
| std::vector< NXString > & | values | ||
| ) |
Creates a NXOpen::Assemblies::AttributeSearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype queryName Name of the saved query upon which this search term is based entries search criteria entries values search criteria values
| NXOpen::Assemblies::BoxSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateBoxSearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| NXOpen::Assemblies::BoxSearchTerm::BoxOverlapLogicType | overlapType, | ||
| const NXOpen::Point3d & | bottomCorner, | ||
| const NXOpen::Point3d & | topCorner, | ||
| bool | trueShapeRefinement | ||
| ) |
Creates a NXOpen::Assemblies::BoxSearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype overlapType overlaptype bottomCorner Vertex of zone in workset part coordinates topCorner Opposite vertex of zone in workset part coordinates trueShapeRefinement Apply TrueShape refinement to volume search
| NXOpen::Assemblies::ExplicitSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateExplicitSearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| NXOpen::Assemblies::SearchResultElement * | searchResultElement | ||
| ) |
Creates a NXOpen::Assemblies::ExplicitSearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype searchResultElement searchresultelement
| NXOpen::Assemblies::GroupSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateExplicitSearchTermGroup | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const std::vector< NXOpen::Assemblies::SearchResultElement * > & | searchResultElements | ||
| ) |
Creates a NXOpen::Assemblies::GroupSearchTerm of NXOpen::Assemblies::ExplicitSearchTerm s and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype searchResultElements searchresultelements
| NXOpen::Assemblies::PartitionSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreatePartitionSearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| NXOpen::Assemblies::Partition * | partition | ||
| ) |
Creates a NXOpen::Assemblies::PartitionSearchTerm and adds it to the recipe at the end of the list of search terms.
Child partitions of the partition being passed as a parameter are not included in the recipe.
- Returns
- Deprecated:
- Deprecated in NX11.0.0. Use the NXOpen::Assemblies::SubsetRecipe::CreatePartitionSearchTerm that gives specific control on whether or not to include children partition as well
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype partition The partition upon which this search term is based
| NXOpen::Assemblies::PartitionSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreatePartitionSearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| NXOpen::Assemblies::PartitionSearchTerm::IncludeChildren | includeChildrenLogic, | ||
| NXOpen::Assemblies::Partition * | partition | ||
| ) |
Creates a NXOpen::Assemblies::PartitionSearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX11.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype includeChildrenLogic includechildrenlogic partition The partition upon which this search term is based
| NXOpen::Assemblies::GroupSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreatePartitionSearchTermGroup | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const std::vector< NXOpen::Assemblies::Partition * > & | partitions | ||
| ) |
Creates a NXOpen::Assemblies::GroupSearchTerm of NXOpen::Assemblies::PartitionSearchTerm s and adds it to the recipe at the end of the list of search terms.
Child partitions of the partitions being passed as a parameter are not included in the recipe.
- Returns
- Deprecated:
- Deprecated in NX11.0.0. Use the NXOpen::Assemblies::SubsetRecipe::CreatePartitionSearchTermGroup that gives specific control on whether or not to include children partition as well
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype partitions partitions
| NXOpen::Assemblies::GroupSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreatePartitionSearchTermGroup | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| NXOpen::Assemblies::PartitionSearchTerm::IncludeChildren | includeChildrenLogic, | ||
| const std::vector< NXOpen::Assemblies::Partition * > & | partitions | ||
| ) |
Creates a NXOpen::Assemblies::GroupSearchTerm of NXOpen::Assemblies::PartitionSearchTerm s and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX11.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype includeChildrenLogic includechildrenlogic partitions partitions
| NXOpen::Assemblies::PlaneSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreatePlaneSearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| NXOpen::Assemblies::PlaneSearchTerm::PlaneOverlapLogicType | overlapType, | ||
| const NXOpen::Vector3d & | normal, | ||
| double | displacement, | ||
| const NXOpen::Point3d & | pointOnPlane, | ||
| bool | trueShapeRefinement | ||
| ) |
Creates a NXOpen::Assemblies::PlaneSearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype overlapType overlaptype normal Unitized plane normal displacement Displacement in workset part units pointOnPlane Point On Plane in workset part coordinates trueShapeRefinement Apply TrueShape refinement to plane search
| NXOpen::Assemblies::ProximitySearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateProximitySearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const std::vector< NXOpen::Assemblies::SearchResultElement * > & | seeds, | ||
| double | distance, | ||
| bool | trueShapeRefinement | ||
| ) |
Creates a NXOpen::Assemblies::ProximitySearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype seeds seeds distance Distance in workset part units trueShapeRefinement Apply TrueShape refinement to proximity search
| NXOpen::Assemblies::RunContentProximitySearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateRunContentProximitySearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const NXString & | seedRunName, | ||
| double | distance, | ||
| bool | trueShapeRefinement | ||
| ) |
Creates a NXOpen::Assemblies::RunContentProximitySearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX11.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype seedRunName The contents of this Run will be seeds for the proximity distance Distance in workset part units trueShapeRefinement Apply TrueShape refinement to proximity search
| NXOpen::Assemblies::RunContentProximitySearchTerm* NXOpen::Assemblies::SubsetRecipe::CreateRunContentProximitySearchTerm | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const char * | seedRunName, | ||
| double | distance, | ||
| bool | trueShapeRefinement | ||
| ) |
Creates a NXOpen::Assemblies::RunContentProximitySearchTerm and adds it to the recipe at the end of the list of search terms.
- Returns
Created in NX11.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype seedRunName The contents of this Run will be seeds for the proximity distance Distance in workset part units trueShapeRefinement Apply TrueShape refinement to proximity search
| void NXOpen::Assemblies::SubsetRecipe::DeleteSearchTerms | ( | const std::vector< NXOpen::Assemblies::SearchTerm * > & | searchTerms | ) |
Removes the NXOpen::Assemblies::SearchTerm s from the recipe and deletes them.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
searchTerms searchterms
| iterator NXOpen::Assemblies::SubsetRecipe::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Assemblies::SearchTerm* NXOpen::Assemblies::SubsetRecipe::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the NXOpen::Assemblies::SearchTerm 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
- Search term found, or null if no such search term exists.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
journalIdentifier Name of the search term to be found
| NXOpen::Assemblies::SearchTerm* NXOpen::Assemblies::SubsetRecipe::FindObject | ( | const char * | journalIdentifier | ) |
Finds the NXOpen::Assemblies::SearchTerm 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
- Search term found, or null if no such search term exists.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
journalIdentifier Name of the search term to be found
| std::vector<NXString> NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptions | ( | const NXString & | optionSet | ) |
Gets the internal names of all search options from specified option set as defined in database.
The option set should be internal name as defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptionSets to get all the option sets internal name defined in database.
- Returns
Created in NX10.0.0.
License requirements : None
- Parameters
-
optionSet optionset
| std::vector<NXString> NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptions | ( | const char * | optionSet | ) |
Gets the internal names of all search options from specified option set as defined in database.
The option set should be internal name as defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptionSets to get all the option sets internal name defined in database.
- Returns
Created in NX10.0.0.
License requirements : None
- Parameters
-
optionSet optionset
| std::vector<NXString> NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptionSets | ( | ) |
Gets the internal names of all option sets defined in database.
- Returns
Created in NX10.0.0.
License requirements : None
| bool NXOpen::Assemblies::SubsetRecipe::GetSearchOptionValue | ( | const NXString & | optionSet, |
| const NXString & | searchOption | ||
| ) |
Gets value of specified search option from given option set.
Both option set and search option should be internal name as defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptionSets to get all the option set internal names defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptions to get all the search option internal names defined in database.
- Returns
Created in NX10.0.0.
License requirements : None
- Parameters
-
optionSet optionset searchOption searchoption
| bool NXOpen::Assemblies::SubsetRecipe::GetSearchOptionValue | ( | const char * | optionSet, |
| const char * | searchOption | ||
| ) |
Gets value of specified search option from given option set.
Both option set and search option should be internal name as defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptionSets to get all the option set internal names defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptions to get all the search option internal names defined in database.
- Returns
Created in NX10.0.0.
License requirements : None
- Parameters
-
optionSet optionset searchOption searchoption
| void NXOpen::Assemblies::SubsetRecipe::Group | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const std::vector< NXOpen::Assemblies::SearchTerm * > & | searchTerms | ||
| ) |
Put the NXOpen::Assemblies::SearchTerm s in a new NXOpen::Assemblies::GroupSearchTerm .
The group is placed in the recipe at the location of the first search term.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype searchTerms searchterms
| void NXOpen::Assemblies::SubsetRecipe::MoveDown | ( | NXOpen::Assemblies::SearchTerm * | searchTerm | ) |
Move a NXOpen::Assemblies::SearchTerm down to another location in the recipe.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
searchTerm searchterm
| void NXOpen::Assemblies::SubsetRecipe::MoveUp | ( | NXOpen::Assemblies::SearchTerm * | searchTerm | ) |
Move a NXOpen::Assemblies::SearchTerm up to another location in the recipe.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
searchTerm searchterm
| void NXOpen::Assemblies::SubsetRecipe::SetPartitionSearchTermLogic | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| NXOpen::Assemblies::PartitionSearchTerm::IncludeChildren | includeChildrenLogic, | ||
| const std::vector< NXOpen::Assemblies::SearchTerm * > & | searchTerms | ||
| ) |
Changes the search term include children logic of each NXOpen::Assemblies::PartitionSearchTerm s passed in.
Created in NX11.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype includeChildrenLogic includechildrenlogic searchTerms searchterms
| void NXOpen::Assemblies::SubsetRecipe::SetSearchOptionValue | ( | const NXString & | optionSet, |
| const NXString & | searchOption, | ||
| bool | optionValue | ||
| ) |
Sets value of specified search option from given option set.
Both option set and search option should be internal name as defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptionSets to get all the option set internal names defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptions to get all the search option internal names defined in database.
Created in NX10.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
optionSet optionset searchOption searchoption optionValue optionvalue
| void NXOpen::Assemblies::SubsetRecipe::SetSearchOptionValue | ( | const char * | optionSet, |
| const char * | searchOption, | ||
| bool | optionValue | ||
| ) |
Sets value of specified search option from given option set.
Both option set and search option should be internal name as defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptionSets to get all the option set internal names defined in database. Use NXOpen::Assemblies::SubsetRecipe::GetAllSearchOptions to get all the search option internal names defined in database.
Created in NX10.0.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
optionSet optionset searchOption searchoption optionValue optionvalue
| void NXOpen::Assemblies::SubsetRecipe::SetSearchTermLogic | ( | NXOpen::Assemblies::SearchTerm::SearchTermLogicType | logicType, |
| const std::vector< NXOpen::Assemblies::SearchTerm * > & | searchTerms | ||
| ) |
Changes the search term logic of each NXOpen::Assemblies::SearchTerm s passed in.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType logictype searchTerms searchterms
| tag_t NXOpen::Assemblies::SubsetRecipe::Tag | ( | ) | const |
Returns the tag of this object.
| void NXOpen::Assemblies::SubsetRecipe::Ungroup | ( | const std::vector< NXOpen::Assemblies::SearchTerm * > & | searchTerms | ) |
Any NXOpen::Assemblies::GroupSearchTerm s in the input search terms will be removed from the recipe.
The members of the group will be re-parented as members of the group's parent.
Created in NX8.5.0.
License requirements : nx_4gd_integration ("4th Generation Design")
- Parameters
-
searchTerms searchterms
The documentation for this class was generated from the following file:
- Assemblies_SubsetRecipe.hxx