A subset recipe is used by a NXOpen.Assemblies.SubsetBuilder to collect NXOpen.Assemblies.SearchTerm s. More...
Protected Member Functions | |
| override int | EnumerateMoveNext (ref Tag currentTag, byte[] state) |
| Advances the enumerator to the next element of the collection. More... | |
Properties | |
| Tag | Tag [get] |
| Returns the tag of this object. 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
| unsafe 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
| unsafe NXOpen.Assemblies.AttributeSearchTerm NXOpen.Assemblies.SubsetRecipe.CreateAttributeSearchTerm | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| string | queryName, | ||
| string[] | entries, | ||
| string[] | values | ||
| ) |
Creates a NXOpen.Assemblies.AttributeSearchTerm and adds it 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
-
logicType queryName Name of the saved query upon which this search term is based entries search criteria entries values search criteria values
- Returns
| unsafe NXOpen.Assemblies.BoxSearchTerm NXOpen.Assemblies.SubsetRecipe.CreateBoxSearchTerm | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| NXOpen.Assemblies.BoxSearchTerm.BoxOverlapLogicType | overlapType, | ||
| NXOpen.Point3d | bottomCorner, | ||
| 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.
Created in NX8.5.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType 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
- Returns
| unsafe 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.
Created in NX8.5.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType searchResultElement
- Returns
| unsafe NXOpen.Assemblies.GroupSearchTerm NXOpen.Assemblies.SubsetRecipe.CreateExplicitSearchTermGroup | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| 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.
Created in NX8.5.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType searchResultElements
- Returns
| unsafe 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.
Created in NX8.5.0
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
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType partition The partition upon which this search term is based
- Returns
| unsafe 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.
Created in NX11.0.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType includeChildrenLogic partition The partition upon which this search term is based
- Returns
| unsafe NXOpen.Assemblies.GroupSearchTerm NXOpen.Assemblies.SubsetRecipe.CreatePartitionSearchTermGroup | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| 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.
Created in NX8.5.0
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
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType partitions
- Returns
| unsafe NXOpen.Assemblies.GroupSearchTerm NXOpen.Assemblies.SubsetRecipe.CreatePartitionSearchTermGroup | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| NXOpen.Assemblies.PartitionSearchTerm.IncludeChildren | includeChildrenLogic, | ||
| 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.
Created in NX11.0.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType includeChildrenLogic partitions
- Returns
| unsafe NXOpen.Assemblies.PlaneSearchTerm NXOpen.Assemblies.SubsetRecipe.CreatePlaneSearchTerm | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| NXOpen.Assemblies.PlaneSearchTerm.PlaneOverlapLogicType | overlapType, | ||
| NXOpen.Vector3d | normal, | ||
| double | displacement, | ||
| 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.
Created in NX8.5.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType 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
- Returns
| unsafe NXOpen.Assemblies.ProximitySearchTerm NXOpen.Assemblies.SubsetRecipe.CreateProximitySearchTerm | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| 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.
Created in NX8.5.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
logicType seeds distance Distance in workset part units trueShapeRefinement Apply TrueShape refinement to proximity search
- Returns
| unsafe NXOpen.Assemblies.RunContentProximitySearchTerm NXOpen.Assemblies.SubsetRecipe.CreateRunContentProximitySearchTerm | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| string | 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.
Created in NX11.0.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
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
- Returns
| unsafe void NXOpen.Assemblies.SubsetRecipe.DeleteSearchTerms | ( | 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
|
protected |
Advances the enumerator to the next element of the collection.
| unsafe NXOpen.Assemblies.SearchTerm NXOpen.Assemblies.SubsetRecipe.FindObject | ( | string | 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.
Created in NX8.5.0
License requirements: nx_4gd_integration ("4th Generation Design")
- Parameters
-
journalIdentifier Name of the search term to be found
- Returns
- Search term found, or null if no such search term exists.
| unsafe string [] NXOpen.Assemblies.SubsetRecipe.GetAllSearchOptions | ( | string | 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.
Created in NX10.0.0
License requirements: None.
- Parameters
-
optionSet
- Returns
| unsafe string [] NXOpen.Assemblies.SubsetRecipe.GetAllSearchOptionSets | ( | ) |
Gets the internal names of all option sets defined in database.
Created in NX10.0.0
License requirements: None.
- Returns
| unsafe bool NXOpen.Assemblies.SubsetRecipe.GetSearchOptionValue | ( | string | optionSet, |
| string | 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.
Created in NX10.0.0
License requirements: None.
- Parameters
-
optionSet searchOption
- Returns
| unsafe void NXOpen.Assemblies.SubsetRecipe.Group | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| 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 searchTerms
| unsafe 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
| unsafe 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
| unsafe void NXOpen.Assemblies.SubsetRecipe.SetPartitionSearchTermLogic | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| NXOpen.Assemblies.PartitionSearchTerm.IncludeChildren | includeChildrenLogic, | ||
| 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 includeChildrenLogic searchTerms
| unsafe void NXOpen.Assemblies.SubsetRecipe.SetSearchOptionValue | ( | string | optionSet, |
| string | 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 searchOption optionValue
| unsafe void NXOpen.Assemblies.SubsetRecipe.SetSearchTermLogic | ( | NXOpen.Assemblies.SearchTerm.SearchTermLogicType | logicType, |
| 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 searchTerms
| NXOpen.Assemblies.SearchTerm [] NXOpen.Assemblies.SubsetRecipe.ToArray | ( | ) |
Returns an array of NXOpen.Assemblies.SearchTerm objects.
| unsafe void NXOpen.Assemblies.SubsetRecipe.Ungroup | ( | 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
Property Documentation
|
get |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- dotnet_pool/Assemblies_SubsetRecipe.cs