PropertyEvaluatorBuilder Class¶
-
class
NXOpen.AME.PropertyEvaluatorBuilder¶ Bases:
NXOpen.AME.BaseEvaluatorBuilderEvaluates the property of an object given a category and property
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreatePropertyEvaluatorBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| BasicProperties | Returns the name and description |
| CategoryName | Returns or sets the category name given by the user |
| PropertyName | Returns or sets the property name given by the user |
| ReferenceObject | Returns the context and source object selection |
| SortingBlock | Returns the sorting block |
| Tag | Returns the Tag for this object. |
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. |
| EstablishEvaluator | Establishes the evaluator |
| 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. |
| 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. |
Property Detail¶
CategoryName¶
-
PropertyEvaluatorBuilder.CategoryName¶ Returns or sets the category name given by the user
-------------------------------------Getter Method
Signature
CategoryNameReturns: Return type: str New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
CategoryNameParameters: categoryName (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
PropertyName¶
-
PropertyEvaluatorBuilder.PropertyName¶ Returns or sets the property name given by the user
-------------------------------------Getter Method
Signature
PropertyNameReturns: Return type: str New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
PropertyNameParameters: propertyName (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
PropertyEvaluatorBuilder.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.