AncestorEvaluatorBuilder Class¶
-
class
NXOpen.AME.
AncestorEvaluatorBuilder
¶ Bases:
NXOpen.AME.BaseEvaluatorBuilder
Evaluates an ancestor for a given aspect and a starting point
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateAncestorEvaluatorBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AspectSelection | Returns or sets the aspect navigator selection type |
BasicProperties | Returns the name and description |
NavCriteria | Returns or sets the navigation criteria |
NavDirection | Returns or sets the navigation direction |
NumLevels | Returns or sets the navigation direction |
ReferenceObject | Returns the context and source object selection |
SelectedType | Returns the selected type |
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¶
AncestorEvaluatorBuilderJaAspectEvaluatorBuilderNavCriteria Enumeration | Choices for navigation criteria - Could be By Levels or By Property |
AncestorEvaluatorBuilderJaAspectEvaluatorBuilderNavDirection Enumeration | Choices for direction of navigation - Could be from starting object upwards, or from root node downwards |
Property Detail¶
AspectSelection¶
-
AncestorEvaluatorBuilder.
AspectSelection
¶ Returns or sets the aspect navigator selection type
-------------------------------------
Getter Method
Signature
AspectSelection
Returns: Return type: NXOpen.AME.BaseEvaluatorBuilderContextType
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
AspectSelection
Parameters: aspectSelection ( NXOpen.AME.BaseEvaluatorBuilderContextType
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
NumLevels¶
-
AncestorEvaluatorBuilder.
NumLevels
¶ Returns or sets the navigation direction
-------------------------------------
Getter Method
Signature
NumLevels
Returns: Return type: int New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
NumLevels
Parameters: numLevels (int) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedType¶
-
AncestorEvaluatorBuilder.
SelectedType
¶ Returns the selected type
-------------------------------------
Getter Method
Signature
SelectedType
Returns: Return type: NXOpen.AME.SelectionEngineeringObjectDefinitionBuilder
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
AncestorEvaluatorBuilder.
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.