A subset recipe is used by a Assemblies::SubsetBuilder to collect SearchTerm s. More...

Inheritance diagram for NXOpen::Assemblies::SubsetRecipe:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Member Functions
void	AddSearchTermBuilder (NXOpen::Assemblies::SearchTermBuilder *searchTermBuilder)
	Add a Assemblies::SearchTermBuilder to the recipe.

iterator	begin ()
	Returns an iterator addressing the first element.

NXOpen::Assemblies::AttributeSearchTerm *	CreateAttributeSearchTerm (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, const NXString &queryName, std::vector< NXString > &entries, std::vector< NXString > &values)
	Creates a Assemblies::AttributeSearchTerm and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::AttributeSearchTerm *	CreateAttributeSearchTerm (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, const char *queryName, std::vector< NXString > &entries, std::vector< NXString > &values)
	Creates a Assemblies::AttributeSearchTerm and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::BoxSearchTerm *	CreateBoxSearchTerm (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, NXOpen::Assemblies::BoxSearchTerm::BoxOverlapLogicType overlapType, const NXOpen::Point3d &bottomCorner, const NXOpen::Point3d &topCorner, bool trueShapeRefinement)
	Creates a Assemblies::BoxSearchTerm and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::ExplicitSearchTerm *	CreateExplicitSearchTerm (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, NXOpen::Assemblies::SearchResultElement *searchResultElement)
	Creates a Assemblies::ExplicitSearchTerm and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::GroupSearchTerm *	CreateExplicitSearchTermGroup (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, const std::vector< NXOpen::Assemblies::SearchResultElement * > &searchResultElements)
	Creates a Assemblies::GroupSearchTerm of Assemblies::ExplicitSearchTerm s and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::PartitionSearchTerm *	CreatePartitionSearchTerm (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, NXOpen::Assemblies::Partition *partition)
	Creates a Assemblies::PartitionSearchTerm and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::GroupSearchTerm *	CreatePartitionSearchTermGroup (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, const std::vector< NXOpen::Assemblies::Partition * > &partitions)
	Creates a Assemblies::GroupSearchTerm of Assemblies::PartitionSearchTerm s and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::PlaneSearchTerm *	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 Assemblies::PlaneSearchTerm and adds it to the recipe at the end of the list of search terms.

NXOpen::Assemblies::ProximitySearchTerm *	CreateProximitySearchTerm (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, const std::vector< NXOpen::Assemblies::SearchResultElement * > &seeds, double distance, bool trueShapeRefinement)
	Creates a Assemblies::ProximitySearchTerm and adds it to the recipe at the end of the list of search terms.

void	DeleteSearchTerms (const std::vector< NXOpen::Assemblies::SearchTerm * > &searchTerms)
	Removes the SearchTerm s from the recipe and deletes them.

iterator	end ()
	Returns an iterator addressing one past the last element.

NXOpen::Assemblies::SearchTerm *	FindObject (const NXString &journalIdentifier)
	Finds the SearchTerm with the given identifier as recorded in a journal.

NXOpen::Assemblies::SearchTerm *	FindObject (const char *journalIdentifier)
	Finds the SearchTerm with the given identifier as recorded in a journal.

void	Group (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, const std::vector< NXOpen::Assemblies::SearchTerm * > &searchTerms)
	Put the SearchTerm s in a new GroupSearchTerm .

void	MoveDown (NXOpen::Assemblies::SearchTerm *searchTerm)
	Move a SearchTerm down to another location in the recipe.

void	MoveUp (NXOpen::Assemblies::SearchTerm *searchTerm)
	Move a SearchTerm up to another location in the recipe.

void	SetSearchTermLogic (NXOpen::Assemblies::SearchTerm::SearchTermLogicType logicType, const std::vector< NXOpen::Assemblies::SearchTerm * > &searchTerms)
	Changes the search term logic of each SearchTerm s passed in.

tag_t	Tag () const
	Returns the tag of this object.

void	Ungroup (const std::vector< NXOpen::Assemblies::SearchTerm * > &searchTerms)
	Any GroupSearchTerm s in the input search terms will be removed from the recipe.

Detailed Description

A subset recipe is used by a Assemblies::SubsetBuilder to collect SearchTerm s.

   The search terms specify the search that defines the contents of a @link Assemblies::Subset Assemblies::Subset@endlink .
<br> To obtain an instance of this class, refer to @link Assemblies::SubsetBuilder  Assemblies::SubsetBuilder @endlink  <br>

Created in NX8.5.0.

Member Function Documentation

void NXOpen::Assemblies::SubsetRecipe::AddSearchTermBuilder ( NXOpen::Assemblies::SearchTermBuilder * searchTermBuilder )

Add a 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 Assemblies::AttributeSearchTerm and adds it to the recipe at the end of the list of search terms.

    @return

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 Assemblies::AttributeSearchTerm and adds it to the recipe at the end of the list of search terms.

    @return

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 Assemblies::BoxSearchTerm and adds it to the recipe at the end of the list of search terms.

    @return

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 Assemblies::ExplicitSearchTerm and adds it to the recipe at the end of the list of search terms.

    @return

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 Assemblies::GroupSearchTerm of Assemblies::ExplicitSearchTerm s and adds it to the recipe at the end of the list of search terms.

    @return

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 Assemblies::PartitionSearchTerm and adds it to the recipe at the end of the list of search terms.

    @return

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::GroupSearchTerm* NXOpen::Assemblies::SubsetRecipe::CreatePartitionSearchTermGroup	(	NXOpen::Assemblies::SearchTerm::SearchTermLogicType	logicType,
		const std::vector< NXOpen::Assemblies::Partition * > &	partitions
	)

Creates a Assemblies::GroupSearchTerm of Assemblies::PartitionSearchTerm s and adds it to the recipe at the end of the list of search terms.

    @return

Created in NX8.5.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

logicType	logictype
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 Assemblies::PlaneSearchTerm and adds it to the recipe at the end of the list of search terms.

    @return

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 Assemblies::ProximitySearchTerm and adds it to the recipe at the end of the list of search terms.

    @return

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

void NXOpen::Assemblies::SubsetRecipe::DeleteSearchTerms ( const std::vector< NXOpen::Assemblies::SearchTerm * > & searchTerms )

Removes the 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 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.  @return  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 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.  @return  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

void NXOpen::Assemblies::SubsetRecipe::Group	(	NXOpen::Assemblies::SearchTerm::SearchTermLogicType	logicType,
		const std::vector< NXOpen::Assemblies::SearchTerm * > &	searchTerms
	)

Put the SearchTerm s in a new 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 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 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::SetSearchTermLogic	(	NXOpen::Assemblies::SearchTerm::SearchTermLogicType	logicType,
		const std::vector< NXOpen::Assemblies::SearchTerm * > &	searchTerms
	)

Changes the search term logic of each 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 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

Classes

Public Member Functions

Detailed Description

Member Function Documentation