This class provides the methods to execute shape search and get the searched results. More...

Inheritance diagram for NXOpen::ShapeSearch::ShapeSearchBuilder:

Public Types
enum	OpenPartType { OpenPartTypeNotSetDisplayPart, OpenPartTypeSetDisplayPartOnlyWhenOpen, OpenPartTypeAlwaysSetDisplayPart }
	The open part type enum. More...

enum	SearchByType { SearchByTypeAttribute, SearchByTypeBody, SearchByTypePart }
	The search type enum. More...

enum	ShapeSimilarity { ShapeSimilarityIdentical, ShapeSimilarityVerySimilar, ShapeSimilaritySimilar }
	The search shape similarity enum. More...

enum	ShapeSize { ShapeSizeP90P110, ShapeSizeP80P120, ShapeSizeP70P130, ShapeSizeP50P200, ShapeSizeP25P400 }
	The search shape size enum. More...

Public Member Functions
int	CustomShapeSizeLowerLimit ()
	Returns the custom shape size lower limit to be set for search.

int	CustomShapeSizeUpperLimit ()
	Returns the custom shape size upper limit to be set for search.

void	ExecuteSearch (bool isNew, const NXString &searchName, int nTotalResults, NXString errorMessage)
	Execute new search or saved search and output error message if error.

void	ExecuteSearch (bool isNew, const char searchName, int nTotalResults, NXString *errorMessage)
	Execute new search or saved search and output error message if error.

std::vector< NXString >	GetInputAttributesFilter ()
	The input attributes filter to be searched.

std::vector< NXString >	GetInputAttributesName ()
	The input attributes name to be searched.

void	GetResults (const NXString &searchName, int startResultId, int endResultId)
	Get specified search results from database.

void	GetResults (const char *searchName, int startResultId, int endResultId)
	Get specified search results from database.

NXOpen::SelectNXObjectList *	InputBody ()
	Returns the input body to be searched Created in NX6.0.0.

NXString	InputPart ()
	Returns the input part to be searched Created in NX6.0.0.

void	OpenResultPart (NXOpen::ShapeSearch::ShapeSearchBuilder::OpenPartType openPartType, const NXString &searchName, int resultId)
	Open the searched result part.

void	OpenResultPart (NXOpen::ShapeSearch::ShapeSearchBuilder::OpenPartType openPartType, const char *searchName, int resultId)
	Open the searched result part.

NXString	ReferenceSetName ()
	Returns the part reference set name to be set for search Created in NX6.0.0.

NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSimilarity	SearchShapeSimilarity ()
	Returns the shape similarity to be set for search Created in NX6.0.0.

NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSize	SearchShapeSize ()
	Returns the shape size to be set for search.

NXOpen::ShapeSearch::ShapeSearchBuilder::SearchByType	SearchType ()
	Returns the search type Created in NX6.0.0.

void	SetCustomShapeSizeLowerLimit (int customShapeSizeLowerLimit)
	Sets the custom shape size lower limit to be set for search.

void	SetCustomShapeSizeUpperLimit (int customShapeSizeUpperLimit)
	Sets the custom shape size upper limit to be set for search.

void	SetInputAttributesFilter (std::vector< NXString > &inputAttributesFilter)
	The input attributes filter to be searched Created in NX6.0.0.

void	SetInputAttributesName (std::vector< NXString > &inputAttributesName)
	The input attributes name to be searched Created in NX6.0.0.

void	SetInputPart (const NXString &inputPart)
	Sets the input part to be searched Created in NX6.0.0.

void	SetInputPart (const char *inputPart)
	Sets the input part to be searched Created in NX6.0.0.

void	SetReferenceSetName (const NXString &referenceSetName)
	Sets the part reference set name to be set for search Created in NX6.0.0.

void	SetReferenceSetName (const char *referenceSetName)
	Sets the part reference set name to be set for search Created in NX6.0.0.

void	SetSearchShapeSimilarity (NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSimilarity searchShapeSimilarity)
	Sets the shape similarity to be set for search Created in NX6.0.0.

void	SetSearchShapeSize (NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSize searchShapeSize)
	Sets the shape size to be set for search.

void	SetSearchType (NXOpen::ShapeSearch::ShapeSearchBuilder::SearchByType searchType)
	Sets the search type Created in NX6.0.0.

void	SetUseCustomShapeSize (bool useCustomShapeSize)
	Sets the use custom shape size to control use shape size option or custom shape size Created in NX6.0.0.

bool	UseCustomShapeSize ()
	Returns the use custom shape size to control use shape size option or custom shape size Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

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

Detailed Description

This class provides the methods to execute shape search and get the searched results.

    The operation that this builder supports has three types: (set by @link ShapeSearch::ShapeSearchBuilder::SetSearchType ShapeSearch::ShapeSearchBuilder::SetSearchType@endlink )
    <ol>
       <li> Search by attributes.
       <ul>
          <li> @link ShapeSearch::ShapeSearchBuilder::SetInputAttributesName ShapeSearch::ShapeSearchBuilder::SetInputAttributesName@endlink  </li>
          <li> @link ShapeSearch::ShapeSearchBuilder::SetInputAttributesFilter ShapeSearch::ShapeSearchBuilder::SetInputAttributesFilter@endlink  </li>
       </ul>
       </li>

       <li>Search by body combined attributes with shape similarity and shape size condition. Support multiple bodies.
       <ul>
          <li> @link ShapeSearch::ShapeSearchBuilder::InputBody ShapeSearch::ShapeSearchBuilder::InputBody@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetInputAttributesName ShapeSearch::ShapeSearchBuilder::SetInputAttributesName@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetInputAttributesFilter ShapeSearch::ShapeSearchBuilder::SetInputAttributesFilter@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetSearchShapeSimilarity ShapeSearch::ShapeSearchBuilder::SetSearchShapeSimilarity@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetSearchShapeSize ShapeSearch::ShapeSearchBuilder::SetSearchShapeSize@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetUseCustomShapeSize ShapeSearch::ShapeSearchBuilder::SetUseCustomShapeSize@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeLowerLimit ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeLowerLimit@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeUpperLimit ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeUpperLimit@endlink  </li>
       </ul>
       </li>

       <li>Search by part combined attributes with shape similarity and shape size condition. Support loaded part, OS part, Teamcenter part and component.
       <ul>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetInputPart ShapeSearch::ShapeSearchBuilder::SetInputPart@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetInputAttributesName ShapeSearch::ShapeSearchBuilder::SetInputAttributesName@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetInputAttributesFilter ShapeSearch::ShapeSearchBuilder::SetInputAttributesFilter@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetReferenceSetName ShapeSearch::ShapeSearchBuilder::SetReferenceSetName@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetSearchShapeSimilarity ShapeSearch::ShapeSearchBuilder::SetSearchShapeSimilarity@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetSearchShapeSize ShapeSearch::ShapeSearchBuilder::SetSearchShapeSize@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetUseCustomShapeSize ShapeSearch::ShapeSearchBuilder::SetUseCustomShapeSize@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeLowerLimit ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeLowerLimit@endlink  </li>
           <li> @link ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeUpperLimit ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeUpperLimit@endlink  </li>
       </ul>
       </li>

    When initialize builder, we will load all saved searches from work directory and add them to
    search list. You can implement 
    @link ShapeSearch::ShapeSearchBuilder::ExecuteSearch ShapeSearch::ShapeSearchBuilder::ExecuteSearch@endlink  to run the saved search.

    After define the search criteria, function @link ShapeSearch::ShapeSearchBuilder::ExecuteSearch ShapeSearch::ShapeSearchBuilder::ExecuteSearch@endlink  can search
    the shape from database and return the searched results count and error message if fails.  The search is specified by 'searchName' parameter.

    The method @link ShapeSearch::ShapeSearchBuilder::GetResults ShapeSearch::ShapeSearchBuilder::GetResults@endlink   can get the specified results from database.         The range of results is specified by the parameters 'startResultId' and 'endResultId', the search is
    specified by 'searchName' parameter.

    The method @link ShapeSearch::ShapeSearchBuilder::OpenResultPart ShapeSearch::ShapeSearchBuilder::OpenResultPart@endlink  can open the selected result part of the
    specified search. The result is specified by 'resultId' parameter, the search is specified by 'searchName' parameter.

 <br> To create a new instance of this class, use @link ShapeSearch::SearchManager::CreateShapeSearchBuilder  ShapeSearch::SearchManager::CreateShapeSearchBuilder @endlink  <br>

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::ShapeSearch::ShapeSearchBuilder::OpenPartType

The open part type enum.

Enumerator:

OpenPartTypeNotSetDisplayPart	Not set the opened part as display part.
OpenPartTypeSetDisplayPartOnlyWhenOpen	Set the opened part as display part only when it doesn't exist in the session.
OpenPartTypeAlwaysSetDisplayPart	Always set the opened part as display part whether it exists in the session.

enum NXOpen::ShapeSearch::ShapeSearchBuilder::SearchByType

The search type enum.

Enumerator:

SearchByTypeAttribute	search by attributes
SearchByTypeBody	search by bodies
SearchByTypePart	search by part

enum NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSimilarity

The search shape similarity enum.

Enumerator:

ShapeSimilarityIdentical	search with identical condition
ShapeSimilarityVerySimilar	search with very similar condition
ShapeSimilaritySimilar	search with similar condition

enum NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSize

The search shape size enum.

Enumerator:

ShapeSizeP90P110	search with shape size 90%-110% condition
ShapeSizeP80P120	search with shape size 80%-120% condition
ShapeSizeP70P130	search with shape size 70%-130% condition
ShapeSizeP50P200	search with shape size 50%-200% condition
ShapeSizeP25P400	search with shape size 25%-400% condition

Member Function Documentation

int NXOpen::ShapeSearch::ShapeSearchBuilder::CustomShapeSizeLowerLimit ( )

Returns the custom shape size lower limit to be set for search.

It is used only when use custom shape size is true. It must be greater than zero and less than upper limit.
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

int NXOpen::ShapeSearch::ShapeSearchBuilder::CustomShapeSizeUpperLimit ( )

Returns the custom shape size upper limit to be set for search.

It is used only when use custom shape size is true. It must be greater than lower limit.
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

void NXOpen::ShapeSearch::ShapeSearchBuilder::ExecuteSearch	(	bool	isNew,
		const NXString &	searchName,
		int *	nTotalResults,
		NXString *	errorMessage
	)

Execute new search or saved search and output error message if error.

Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

isNew	True is executing new search, False is executing saved search
searchName	Search name NOTE: The full Unicode character set is not supported for this parameter.
nTotalResults	Search result total number
errorMessage	Search error message

void NXOpen::ShapeSearch::ShapeSearchBuilder::ExecuteSearch	(	bool	isNew,
		const char *	searchName,
		int *	nTotalResults,
		NXString *	errorMessage
	)

Execute new search or saved search and output error message if error.

Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

isNew	True is executing new search, False is executing saved search
searchName	Search name NOTE: The full Unicode character set is not supported for this parameter.
nTotalResults	Search result total number
errorMessage	Search error message

std::vector<NXString> NXOpen::ShapeSearch::ShapeSearchBuilder::GetInputAttributesFilter ( )

The input attributes filter to be searched.

Returns: Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

std::vector<NXString> NXOpen::ShapeSearch::ShapeSearchBuilder::GetInputAttributesName ( )

The input attributes name to be searched.

Returns: Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

void NXOpen::ShapeSearch::ShapeSearchBuilder::GetResults	(	const NXString &	searchName,
		int	startResultId,
		int	endResultId
	)

Get specified search results from database.

Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

searchName	Search name NOTE: The full Unicode character set is not supported for this parameter.
startResultId	Start result id
endResultId	End result id

void NXOpen::ShapeSearch::ShapeSearchBuilder::GetResults	(	const char *	searchName,
		int	startResultId,
		int	endResultId
	)

Get specified search results from database.

Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

searchName	Search name NOTE: The full Unicode character set is not supported for this parameter.
startResultId	Start result id
endResultId	End result id

NXOpen::SelectNXObjectList* NXOpen::ShapeSearch::ShapeSearchBuilder::InputBody ( )

Returns the input body to be searched
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

NXString NXOpen::ShapeSearch::ShapeSearchBuilder::InputPart ( )

Returns the input part to be searched
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

void NXOpen::ShapeSearch::ShapeSearchBuilder::OpenResultPart	(	NXOpen::ShapeSearch::ShapeSearchBuilder::OpenPartType	openPartType,
		const NXString &	searchName,
		int	resultId
	)

Open the searched result part.

Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

openPartType	Open part type
searchName	Search name NOTE: The full Unicode character set is not supported for this parameter.
resultId	Result id

void NXOpen::ShapeSearch::ShapeSearchBuilder::OpenResultPart	(	NXOpen::ShapeSearch::ShapeSearchBuilder::OpenPartType	openPartType,
		const char *	searchName,
		int	resultId
	)

Open the searched result part.

Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

openPartType	Open part type
searchName	Search name NOTE: The full Unicode character set is not supported for this parameter.
resultId	Result id

NXString NXOpen::ShapeSearch::ShapeSearchBuilder::ReferenceSetName ( )

Returns the part reference set name to be set for search
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSimilarity NXOpen::ShapeSearch::ShapeSearchBuilder::SearchShapeSimilarity ( )

Returns the shape similarity to be set for search
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSize NXOpen::ShapeSearch::ShapeSearchBuilder::SearchShapeSize ( )

Returns the shape size to be set for search.

It is used only when use custom shape size is false.
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

NXOpen::ShapeSearch::ShapeSearchBuilder::SearchByType NXOpen::ShapeSearch::ShapeSearchBuilder::SearchType ( )

Returns the search type
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeLowerLimit ( int customShapeSizeLowerLimit )

Sets the custom shape size lower limit to be set for search.

It is used only when use custom shape size is true. It must be greater than zero and less than upper limit.
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

customShapeSizeLowerLimit customshapesizelowerlimit

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetCustomShapeSizeUpperLimit ( int customShapeSizeUpperLimit )

Sets the custom shape size upper limit to be set for search.

It is used only when use custom shape size is true. It must be greater than lower limit.
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

customShapeSizeUpperLimit customshapesizeupperlimit

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetInputAttributesFilter ( std::vector< NXString > & inputAttributesFilter )

The input attributes filter to be searched
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

inputAttributesFilter Search attributes filter
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetInputAttributesName ( std::vector< NXString > & inputAttributesName )

The input attributes name to be searched
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

inputAttributesName Search attributes Name
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetInputPart ( const NXString & inputPart )

Sets the input part to be searched
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

inputPart inputpart

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetInputPart ( const char * inputPart )

Sets the input part to be searched
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

inputPart inputpart

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetReferenceSetName ( const NXString & referenceSetName )

Sets the part reference set name to be set for search
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

referenceSetName referencesetname

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetReferenceSetName ( const char * referenceSetName )

Sets the part reference set name to be set for search
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

referenceSetName referencesetname

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetSearchShapeSimilarity ( NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSimilarity searchShapeSimilarity )

Sets the shape similarity to be set for search
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

searchShapeSimilarity searchshapesimilarity

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetSearchShapeSize ( NXOpen::ShapeSearch::ShapeSearchBuilder::ShapeSize searchShapeSize )

Sets the shape size to be set for search.

It is used only when use custom shape size is false.
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

searchShapeSize searchshapesize

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetSearchType ( NXOpen::ShapeSearch::ShapeSearchBuilder::SearchByType searchType )

Sets the search type
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

searchType searchtype

void NXOpen::ShapeSearch::ShapeSearchBuilder::SetUseCustomShapeSize ( bool useCustomShapeSize )

Sets the use custom shape size to control use shape size option or custom shape size
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

Parameters

useCustomShapeSize usecustomshapesize

bool NXOpen::ShapeSearch::ShapeSearchBuilder::UseCustomShapeSize ( )

Returns the use custom shape size to control use shape size option or custom shape size
Created in NX6.0.0.

License requirements : shape_search ("Shape Search")

The documentation for this class was generated from the following file:

ShapeSearch_ShapeSearchBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation