AccessorEvaluatorBuilder Class¶
-
class
NXOpen.AME.AccessorEvaluatorBuilder¶ Bases:
NXOpen.AME.BaseEvaluatorBuilderEvaluates an object based on a property value or an index
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateAccessorEvaluatorBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| AccessTypeValue | Returns or sets the access type |
| BasicProperties | Returns the name and description |
| CompareValue | Returns or sets the comparative value given by user |
| ObjectPosition | Returns or sets the object index value given by the user |
| PositionValue | Returns or sets the position value 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. |
Enumerations¶
| AccessorEvaluatorBuilderAccessType Enumeration | Choices for access type either by an index or property |
| AccessorEvaluatorBuilderPositionTypeValue Enumeration | Choices for position to be either begin, end or defined by index |
Property Detail¶
AccessTypeValue¶
-
AccessorEvaluatorBuilder.AccessTypeValue¶ Returns or sets the access type
-------------------------------------Getter Method
Signature
AccessTypeValueReturns: Return type: NXOpen.AME.AccessorEvaluatorBuilderAccessTypeNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
AccessTypeValueParameters: accessType ( NXOpen.AME.AccessorEvaluatorBuilderAccessType) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
CompareValue¶
-
AccessorEvaluatorBuilder.CompareValue¶ Returns or sets the comparative value given by user
-------------------------------------Getter Method
Signature
CompareValueReturns: Return type: str New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
CompareValueParameters: compareValue (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ObjectPosition¶
-
AccessorEvaluatorBuilder.ObjectPosition¶ Returns or sets the object index value given by the user
-------------------------------------Getter Method
Signature
ObjectPositionReturns: Return type: int New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
ObjectPositionParameters: objectPosition (int) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
PositionValue¶
-
AccessorEvaluatorBuilder.PositionValue¶ Returns or sets the position value given by the user
-------------------------------------Getter Method
Signature
PositionValueReturns: Return type: NXOpen.AME.AccessorEvaluatorBuilderPositionTypeValueNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
PositionValueParameters: positionValue ( NXOpen.AME.AccessorEvaluatorBuilderPositionTypeValue) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
PropertyName¶
-
AccessorEvaluatorBuilder.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¶
-
AccessorEvaluatorBuilder.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.