PortEvaluatorBuilder Class

class NXOpen.AME.PortEvaluatorBuilder

Bases: NXOpen.AME.BaseEvaluatorBuilder

Evaluates the port objects for the given port and a starting point

To create a new instance of this class, use NXOpen.AME.AMEManager.CreatePortEvaluatorBuilder()

New in version NX12.0.0.

Properties

Property Description
BasicProperties Returns the name and description
Port Returns or sets the expression that will determine the port.
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

Port

PortEvaluatorBuilder.Port

Returns or sets the expression that will determine the port.

-------------------------------------

Getter Method

Signature Port

Returns:
Return type:str

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature Port

Parameters:port (str) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

Validate

PortEvaluatorBuilder.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.