BaseEvaluatorBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BaseEvaluatorBuilder Class

class `NXOpen.AME.``BaseEvaluatorBuilder`

  Bases: `NXOpen.Builder`

  Represents the builder for all the evaluators.

  Contains mostly the common inputs. This object does not need a creator.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
BasicProperties | Returns the name and description
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

BaseEvaluatorBuilderConditionType Enumeration | choices for condition type filter for navigations that return a list of filtered objects
BaseEvaluatorBuilderContextType Enumeration | choices for aspect context type, can either be function, location, product, or automation

# Property Detail

## BasicProperties

`BaseEvaluatorBuilder.``BasicProperties`

  Returns the name and description

  `-------------------------------------`

  Getter Method

  Signature `BasicProperties`

  Returns: |
  Return type: | `NXOpen.AME.BasicPropertiesBuilder`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## ReferenceObject

`BaseEvaluatorBuilder.``ReferenceObject`

  Returns the context and source object selection

  `-------------------------------------`

  Getter Method

  Signature `ReferenceObject`

  Returns: |
  Return type: | `NXOpen.AME.ReferenceObjectBuilder`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SortingBlock

`BaseEvaluatorBuilder.``SortingBlock`

  Returns the sorting block

  `-------------------------------------`

  Getter Method

  Signature `SortingBlock`

  Returns: |
  Return type: | `NXOpen.AME.SortingBlockBuilder`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

# Method Detail

## EstablishEvaluator

`BaseEvaluatorBuilder.``EstablishEvaluator`

  Establishes the evaluator

  Signature `EstablishEvaluator()`

  Returns: |
  Return type: | `NXOpen.AME.ExpressionEvaluator`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Validate

`BaseEvaluatorBuilder.``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.