TCSavedQueriesBuilder Class¶
-
class
NXOpen.AME.
TCSavedQueriesBuilder
¶ Bases:
NXOpen.Builder
Represents a TC Saved Queries builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateEditQueryScopeBuilder()
New in version NX11.0.0.
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
SetQueryCriteriaName | Set the tc query criteria name |
SetQueryCriteriaValue | Set the tc query criteria value |
SetQueryName | Set the tc query name |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Method Detail¶
SetQueryCriteriaName¶
-
TCSavedQueriesBuilder.
SetQueryCriteriaName
¶ Set the tc query criteria name
Signature
SetQueryCriteriaName(index, queryCriteriaName)
Parameters: - index (int) –
- queryCriteriaName (str) –
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetQueryCriteriaValue¶
-
TCSavedQueriesBuilder.
SetQueryCriteriaValue
¶ Set the tc query criteria value
Signature
SetQueryCriteriaValue(index, queryCriteriaValue)
Parameters: - index (int) –
- queryCriteriaValue (str) –
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetQueryName¶
-
TCSavedQueriesBuilder.
SetQueryName
¶ Set the tc query name
Signature
SetQueryName(queryName)
Parameters: queryName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
TCSavedQueriesBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.