ParameterRuleBuilder Class

class NXOpen.AME.ParameterRuleBuilder

Bases: NXOpen.Builder

JA class for the parameter rule dialog

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

New in version NX12.0.0.

Properties

Property Description
ConnectionType Returns or sets the connection type
ObjectConnection Returns the object connection ui block
ObjectConnectionDetail Returns the object connection detail ui block
SelectionPort Returns the eo any port selection
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.
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.
UpdateConnectionDetail Update embedded connection detail comp
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ParameterRuleBuilderConnection Enumeration connection Type

Property Detail

ConnectionType

ParameterRuleBuilder.ConnectionType

Returns or sets the connection type

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

Getter Method

Signature ConnectionType

Returns:
Return type:NXOpen.AME.ParameterRuleBuilderConnection

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ConnectionType

Parameters:type (NXOpen.AME.ParameterRuleBuilderConnection) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ObjectConnection

ParameterRuleBuilder.ObjectConnection

Returns the object connection ui block

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

Getter Method

Signature ObjectConnection

Returns:
Return type:NXOpen.AME.ObjectConnectionBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ObjectConnectionDetail

ParameterRuleBuilder.ObjectConnectionDetail

Returns the object connection detail ui block

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

Getter Method

Signature ObjectConnectionDetail

Returns:
Return type:NXOpen.AME.ObjectConnectionDetailBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectionPort

ParameterRuleBuilder.SelectionPort

Returns the eo any port selection

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

Getter Method

Signature SelectionPort

Returns:
Return type:NXOpen.AME.SelectAMEBaseNode

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

UpdateConnectionDetail

ParameterRuleBuilder.UpdateConnectionDetail

Update embedded connection detail comp

Signature UpdateConnectionDetail(port, propertyPath)

Parameters:

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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