NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Annotations::SearchModelViewBuilder Class Reference

Represents a NXOpen::Annotations::SearchModelViewBuilder
To create a new instance of this class, use NXOpen::Annotations::SearchModelViewCollection::CreateSearchModelViewBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::SearchModelViewBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PmiTypes {
  PmiTypesDimension, PmiTypesFeatureControlFrame, PmiTypesDatumFeatureSymbol, PmiTypesDatumTarget,
  PmiTypesSurfaceFinish, PmiTypesNote
}
 the search criteria pmitype More...
 
enum  SearchScopeOptions { SearchScopeOptionsWorkPart, SearchScopeOptionsWorkPartAndComponents }
 seaerch scope type More...
 
enum  TextComparisionOptions { TextComparisionOptionsEquals, TextComparisionOptionsContains }
 Represents the text comparision options. More...
 
enum  ValueComparisionOptions {
  ValueComparisionOptionsLess, ValueComparisionOptionsLessEqual, ValueComparisionOptionsEqual, ValueComparisionOptionsMoreEqual,
  ValueComparisionOptionsMore
}
 Represents the value comparision options. More...
 

Public Member Functions

NXOpen::NXObjectCreateCriteriaObject (NXOpen::Annotations::SearchModelViewBuilder::PmiTypes searchType)
 Create search criteria object in search model view builder. More...
 
NXOpen::TaggedObjectListCriteriaList ()
 Returns the criteria list
Created in NX7.5.0. More...
 
void DeleteCriteriaObject (NXOpen::NXObject *criteriaObject)
 Delete search criteria object in search model view builder
Created in NX7.5.0. More...
 
void ExecuteSearch ()
 TODO: fill in a description for this
Created in NX7.5.0. More...
 
std::vector< NXOpen::NXObject * > GetResults ()
 All results. More...
 
NXString ModelViewName ()
 Returns the name
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchModelViewBuilder::PmiTypes PmiType ()
 Returns the pmi type
Created in NX7.5.0. More...
 
void SaveAsModelView ()
 TODO: fill in a description for this
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchModelViewBuilder::SearchScopeOptions SearchScope ()
 Returns the search scope
Created in NX7.5.0. More...
 
void SetModelViewName (const NXString &modelViewName)
 Sets the name
Created in NX7.5.0. More...
 
void SetModelViewName (const char *modelViewName)
 Sets the name
Created in NX7.5.0. More...
 
void SetPmiType (NXOpen::Annotations::SearchModelViewBuilder::PmiTypes pmiType)
 Sets the pmi type
Created in NX7.5.0. More...
 
void SetSearchScope (NXOpen::Annotations::SearchModelViewBuilder::SearchScopeOptions searchScope)
 Sets the search scope
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

Represents a NXOpen::Annotations::SearchModelViewBuilder
To create a new instance of this class, use NXOpen::Annotations::SearchModelViewCollection::CreateSearchModelViewBuilder
Default values.

Property Value

PmiType

Dimension


Created in NX7.5.0.

Member Enumeration Documentation

the search criteria pmitype

Enumerator
PmiTypesDimension 

dimension type

PmiTypesFeatureControlFrame 

feature control frame type

PmiTypesDatumFeatureSymbol 

datum feature symbol type

PmiTypesDatumTarget 

datum target type

PmiTypesSurfaceFinish 

surface finish type

PmiTypesNote 

note type

seaerch scope type

Enumerator
SearchScopeOptionsWorkPart 

work part only

SearchScopeOptionsWorkPartAndComponents 

work part and components

Represents the text comparision options.

Enumerator
TextComparisionOptionsEquals 

Equals.

TextComparisionOptionsContains 

Contains.

Represents the value comparision options.

Enumerator
ValueComparisionOptionsLess 

less

ValueComparisionOptionsLessEqual 

less equal

ValueComparisionOptionsEqual 

equal

ValueComparisionOptionsMoreEqual 

more equal

ValueComparisionOptionsMore 

more

Member Function Documentation

NXOpen::NXObject* NXOpen::Annotations::SearchModelViewBuilder::CreateCriteriaObject ( NXOpen::Annotations::SearchModelViewBuilder::PmiTypes  searchType)

Create search criteria object in search model view builder.

Returns
criteria object
Created in NX7.5.0.

License requirements : None
Parameters
searchTypesearch type
NXOpen::TaggedObjectList* NXOpen::Annotations::SearchModelViewBuilder::CriteriaList ( )

Returns the criteria list
Created in NX7.5.0.



License requirements : None

void NXOpen::Annotations::SearchModelViewBuilder::DeleteCriteriaObject ( NXOpen::NXObject criteriaObject)

Delete search criteria object in search model view builder
Created in NX7.5.0.



License requirements : None

Parameters
criteriaObjectcriteria Object
void NXOpen::Annotations::SearchModelViewBuilder::ExecuteSearch ( )

TODO: fill in a description for this
Created in NX7.5.0.



License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::Annotations::SearchModelViewBuilder::GetResults ( )

All results.

Returns

Created in NX7.5.0.

License requirements : None
NXString NXOpen::Annotations::SearchModelViewBuilder::ModelViewName ( )

Returns the name
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchModelViewBuilder::PmiTypes NXOpen::Annotations::SearchModelViewBuilder::PmiType ( )

Returns the pmi type
Created in NX7.5.0.



License requirements : None

void NXOpen::Annotations::SearchModelViewBuilder::SaveAsModelView ( )

TODO: fill in a description for this
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchModelViewBuilder::SearchScopeOptions NXOpen::Annotations::SearchModelViewBuilder::SearchScope ( )

Returns the search scope
Created in NX7.5.0.



License requirements : None

void NXOpen::Annotations::SearchModelViewBuilder::SetModelViewName ( const NXString modelViewName)

Sets the name
Created in NX7.5.0.



License requirements : None

Parameters
modelViewNamemodelviewname
void NXOpen::Annotations::SearchModelViewBuilder::SetModelViewName ( const char *  modelViewName)

Sets the name
Created in NX7.5.0.



License requirements : None

Parameters
modelViewNamemodelviewname
void NXOpen::Annotations::SearchModelViewBuilder::SetPmiType ( NXOpen::Annotations::SearchModelViewBuilder::PmiTypes  pmiType)

Sets the pmi type
Created in NX7.5.0.



License requirements : None

Parameters
pmiTypepmitype
void NXOpen::Annotations::SearchModelViewBuilder::SetSearchScope ( NXOpen::Annotations::SearchModelViewBuilder::SearchScopeOptions  searchScope)

Sets the search scope
Created in NX7.5.0.



License requirements : None

Parameters
searchScopesearchscope

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.