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

Represents query class builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateQueryBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::QueryBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Types { TypesNewQuery, TypesFromLibrary }
 the creation type of query More...
 

Public Member Functions

NXOpen::AME::QueryBuilder::Types CreationType ()
 Returns the defined rule type
Created in NX12.0.0. More...
 
NXString Description ()
 Returns the query description
Created in NX11.0.0. More...
 
NXString GetPublicQueryDescription ()
 The selected public query description. More...
 
NXString GetPublicQueryName ()
 The selected public query name. More...
 
NXString Name ()
 Returns the query name
Created in NX11.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeParent ()
 Returns the parent node of query node
Created in NX11.0.0. More...
 
NXOpen::Tooling::SelectReuseLibraryItemBuilderReuseLibraryItem ()
 Returns the public query
Created in NX12.0.0. More...
 
void SetCreationType (NXOpen::AME::QueryBuilder::Types type)
 Sets the defined rule type
Created in NX12.0.0. More...
 
void SetDescription (const NXString &description)
 Sets the query description
Created in NX11.0.0. More...
 
void SetDescription (const char *description)
 Sets the query description
Created in NX11.0.0. More...
 
void SetName (const NXString &name)
 Sets the query name
Created in NX11.0.0. More...
 
void SetName (const char *name)
 Sets the query name
Created in NX11.0.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 query class builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateQueryBuilder

Created in NX11.0.0.


Member Enumeration Documentation

the creation type of query

Enumerator
TypesNewQuery 

new query

TypesFromLibrary 

from library

Member Function Documentation

NXOpen::AME::QueryBuilder::Types NXOpen::AME::QueryBuilder::CreationType ( )

Returns the defined rule type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::QueryBuilder::Description ( )

Returns the query description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::QueryBuilder::GetPublicQueryDescription ( )

The selected public query description.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
NXString NXOpen::AME::QueryBuilder::GetPublicQueryName ( )

The selected public query name.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
NXString NXOpen::AME::QueryBuilder::Name ( )

Returns the query name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::QueryBuilder::Parent ( )

Returns the parent node of query node
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::AME::QueryBuilder::ReuseLibraryItem ( )

Returns the public query
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::QueryBuilder::SetCreationType ( NXOpen::AME::QueryBuilder::Types  type)

Sets the defined rule type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
void NXOpen::AME::QueryBuilder::SetDescription ( const NXString description)

Sets the query description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::QueryBuilder::SetDescription ( const char *  description)

Sets the query description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::QueryBuilder::SetName ( const NXString name)

Sets the query name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
namename
void NXOpen::AME::QueryBuilder::SetName ( const char *  name)

Sets the query name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
namename

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