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

Naming Rule Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateEditClauseBuilder
Default values. More...

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

Public Types

enum  Operator { OperatorAs, OperatorUnder, OperatorOfType }
 the query operator More...
 
enum  QueryClauseOperatorType { QueryClauseOperatorTypeAnd, QueryClauseOperatorTypeOr, QueryClauseOperatorTypeNone }
 the clause operator More...
 
enum  Types { TypesClassification, TypesLibraryObject, TypesAspect }
 the type of object to be used for edit clause More...
 

Public Member Functions

bool AllAspects ()
 Returns the all aspects option status whether ON or OFF
Created in NX11.0.0. More...
 
NXOpen::AME::EditClauseBuilder::Operator AspectOperator ()
 Returns the query operator for Aspect object
Created in NX11.0.0. More...
 
NXOpen::AME::EditClauseBuilder::Operator ClassificationOperator ()
 Returns the query operator for Classification object
Created in NX11.0.0. More...
 
NXOpen::AME::EditClauseBuilder::QueryClauseOperatorType ClauseOperator ()
 Returns the clause operator of query
Created in NX12.0.0. More...
 
NXOpen::AME::EditClauseBuilder::Operator ReuseLibraryOperator ()
 Returns the query operator for Reuse Library object
Created in NX11.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeSelectAspect ()
 Returns the selected aspect
Created in NX11.0.0. More...
 
NXOpen::AME::SelectClassificationBuilderSelectClassification ()
 Returns the selected classification
Created in NX11.0.0. More...
 
NXOpen::AME::AMEQuerySelectedQuery ()
 Returns the query object
Created in NX12.0.0. More...
 
NXOpen::AME::QueryClauseSelectedQueryClause ()
 Returns the selected query clause
Created in NX12.0.0. More...
 
NXOpen::AME::SelectionEngineeringObjectDefinitionBuilderSelectFromMemberSelect ()
 Returns the engineering object definition
More...
 
NXOpen::AME::SelectionBaseDefinitionBuilderSelectLibraryObject ()
 Returns the engineering object definition or product definition
Created in NX12.0.0. More...
 
void SetAllAspects (bool toggleAllAspects)
 Sets the all aspects option status whether ON or OFF
Created in NX11.0.0. More...
 
void SetAspectOperator (NXOpen::AME::EditClauseBuilder::Operator aspectOperator)
 Sets the query operator for Aspect object
Created in NX11.0.0. More...
 
void SetClassificationOperator (NXOpen::AME::EditClauseBuilder::Operator classificationOperator)
 Sets the query operator for Classification object
Created in NX11.0.0. More...
 
void SetClauseOperator (NXOpen::AME::EditClauseBuilder::QueryClauseOperatorType clauseOperator)
 Sets the clause operator of query
Created in NX12.0.0. More...
 
void SetProperty (int index, const NXString &propertyName)
 Set the property
Created in NX11.0.0. More...
 
void SetProperty (int index, const char *propertyName)
 Set the property
Created in NX11.0.0. More...
 
void SetPropertyOperator (int index, const NXString &propertyOperator)
 Set the property operator
Created in NX11.0.0. More...
 
void SetPropertyOperator (int index, const char *propertyOperator)
 Set the property operator
Created in NX11.0.0. More...
 
void SetPropertyValue (int index, const NXString &propertyValue)
 Set the property value
Created in NX11.0.0. More...
 
void SetPropertyValue (int index, const char *propertyValue)
 Set the property value
Created in NX11.0.0. More...
 
void SetReuseLibraryOperator (NXOpen::AME::EditClauseBuilder::Operator reuseLibraryOperator)
 Sets the query operator for Reuse Library object
Created in NX11.0.0. More...
 
void SetSelectedQuery (NXOpen::AME::AMEQuery *selectedQuery)
 Sets the query object
Created in NX12.0.0. More...
 
void SetSelectedQueryClause (NXOpen::AME::QueryClause *selectedClause)
 Sets the selected query clause
Created in NX12.0.0. More...
 
void SetType (NXOpen::AME::EditClauseBuilder::Types type)
 Sets the type of object to be used for edit clause NXOpen::AME::EditClauseBuilder::Type. More...
 
NXOpen::AME::EditClauseBuilder::Types Type ()
 Returns the type of object to be used for edit clause NXOpen::AME::EditClauseBuilder::Type. 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

Naming Rule Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateEditClauseBuilder
Default values.

Property Value

AllAspects

0

AspectOperator

Under

ClassificationOperator

As

ClauseOperator

And

ReuseLibraryOperator

OfType


Created in NX11.0.0.

Member Enumeration Documentation

the query operator

Enumerator
OperatorAs 

as

OperatorUnder 

under

OperatorOfType 

of type

the clause operator

Enumerator
QueryClauseOperatorTypeAnd 

and

QueryClauseOperatorTypeOr 

or

QueryClauseOperatorTypeNone 

none

the type of object to be used for edit clause

Enumerator
TypesClassification 

classification

TypesLibraryObject 

library object

TypesAspect 

aspect

Member Function Documentation

bool NXOpen::AME::EditClauseBuilder::AllAspects ( )

Returns the all aspects option status whether ON or OFF
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::EditClauseBuilder::Operator NXOpen::AME::EditClauseBuilder::AspectOperator ( )

Returns the query operator for Aspect object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::EditClauseBuilder::Operator NXOpen::AME::EditClauseBuilder::ClassificationOperator ( )

Returns the query operator for Classification object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::EditClauseBuilder::QueryClauseOperatorType NXOpen::AME::EditClauseBuilder::ClauseOperator ( )

Returns the clause operator of query
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::EditClauseBuilder::Operator NXOpen::AME::EditClauseBuilder::ReuseLibraryOperator ( )

Returns the query operator for Reuse Library object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::EditClauseBuilder::SelectAspect ( )

Returns the selected aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectClassificationBuilder* NXOpen::AME::EditClauseBuilder::SelectClassification ( )

Returns the selected classification
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::AMEQuery* NXOpen::AME::EditClauseBuilder::SelectedQuery ( )

Returns the query object
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::QueryClause* NXOpen::AME::EditClauseBuilder::SelectedQueryClause ( )

Returns the selected query clause
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectionEngineeringObjectDefinitionBuilder* NXOpen::AME::EditClauseBuilder::SelectFromMemberSelect ( )

Returns the engineering object definition

Deprecated:
Deprecated in NX12.0.0.

Use SelectLibraryObject instead.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectionBaseDefinitionBuilder* NXOpen::AME::EditClauseBuilder::SelectLibraryObject ( )

Returns the engineering object definition or product definition
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::EditClauseBuilder::SetAllAspects ( bool  toggleAllAspects)

Sets the all aspects option status whether ON or OFF
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
toggleAllAspectstoggleallaspects
void NXOpen::AME::EditClauseBuilder::SetAspectOperator ( NXOpen::AME::EditClauseBuilder::Operator  aspectOperator)

Sets the query operator for Aspect object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectOperatoraspectoperator
void NXOpen::AME::EditClauseBuilder::SetClassificationOperator ( NXOpen::AME::EditClauseBuilder::Operator  classificationOperator)

Sets the query operator for Classification object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
classificationOperatorclassificationoperator
void NXOpen::AME::EditClauseBuilder::SetClauseOperator ( NXOpen::AME::EditClauseBuilder::QueryClauseOperatorType  clauseOperator)

Sets the clause operator of query
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
clauseOperatorclauseoperator
void NXOpen::AME::EditClauseBuilder::SetProperty ( int  index,
const NXString propertyName 
)

Set the property
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
indexindex
propertyNamepropertyname
void NXOpen::AME::EditClauseBuilder::SetProperty ( int  index,
const char *  propertyName 
)

Set the property
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
indexindex
propertyNamepropertyname
void NXOpen::AME::EditClauseBuilder::SetPropertyOperator ( int  index,
const NXString propertyOperator 
)

Set the property operator
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
indexindex
propertyOperatorpropertyoperator
void NXOpen::AME::EditClauseBuilder::SetPropertyOperator ( int  index,
const char *  propertyOperator 
)

Set the property operator
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
indexindex
propertyOperatorpropertyoperator
void NXOpen::AME::EditClauseBuilder::SetPropertyValue ( int  index,
const NXString propertyValue 
)

Set the property value
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
indexindex
propertyValuepropertyvalue
void NXOpen::AME::EditClauseBuilder::SetPropertyValue ( int  index,
const char *  propertyValue 
)

Set the property value
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
indexindex
propertyValuepropertyvalue
void NXOpen::AME::EditClauseBuilder::SetReuseLibraryOperator ( NXOpen::AME::EditClauseBuilder::Operator  reuseLibraryOperator)

Sets the query operator for Reuse Library object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
reuseLibraryOperatorreuselibraryoperator
void NXOpen::AME::EditClauseBuilder::SetSelectedQuery ( NXOpen::AME::AMEQuery selectedQuery)

Sets the query object
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
selectedQueryselectedquery
void NXOpen::AME::EditClauseBuilder::SetSelectedQueryClause ( NXOpen::AME::QueryClause selectedClause)

Sets the selected query clause
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
selectedClauseselectedclause
void NXOpen::AME::EditClauseBuilder::SetType ( NXOpen::AME::EditClauseBuilder::Types  type)

Sets the type of object to be used for edit clause NXOpen::AME::EditClauseBuilder::Type.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
NXOpen::AME::EditClauseBuilder::Types NXOpen::AME::EditClauseBuilder::Type ( )

Returns the type of object to be used for edit clause NXOpen::AME::EditClauseBuilder::Type.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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