OperatorRuleBuilder Class

class NXOpen.AME.OperatorRuleBuilder

Bases: NXOpen.Builder

OperatorRule Dialog

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

New in version NX12.0.0.

Properties

Property Description
Conditions Returns the conditions block
Negation Returns or sets the Negation of parameter
ObjectConnectionDetail Returns the Variable component
OperatorType Returns or sets the OperatorType
ParameterRuleType Returns or sets the Select Parameter
Port Returns the Object Selection for Global Variable
RuleName Returns or sets the rule name
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CreateParameter Create new parameter
DeleteParameter Deletes parameter
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.
MoveParameter Move existing parameter
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateParameter Update existing parameter
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

OperatorRuleBuilderNegationValue Enumeration Enum of negation value
OperatorRuleBuilderParameterType Enumeration Enum of parameter type

Property Detail

Conditions

OperatorRuleBuilder.Conditions

Returns the conditions block

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

Getter Method

Signature Conditions

Returns:
Return type:NXOpen.AME.ConditionsBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Negation

OperatorRuleBuilder.Negation

Returns or sets the Negation of parameter

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

Getter Method

Signature Negation

Returns:
Return type:NXOpen.AME.OperatorRuleBuilderNegationValue

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Negation

Parameters:negation (NXOpen.AME.OperatorRuleBuilderNegationValue) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ObjectConnectionDetail

OperatorRuleBuilder.ObjectConnectionDetail

Returns the Variable component

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

Getter Method

Signature ObjectConnectionDetail

Returns:
Return type:NXOpen.AME.ObjectConnectionDetailBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

OperatorType

OperatorRuleBuilder.OperatorType

Returns or sets the OperatorType

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

Getter Method

Signature OperatorType

Returns:
Return type:NXOpen.AME.PlcRuleType

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature OperatorType

Parameters:operatorType (NXOpen.AME.PlcRuleType) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ParameterRuleType

OperatorRuleBuilder.ParameterRuleType

Returns or sets the Select Parameter

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

Getter Method

Signature ParameterRuleType

Returns:
Return type:NXOpen.AME.PlcRuleType

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ParameterRuleType

Parameters:ruleType (NXOpen.AME.PlcRuleType) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Port

OperatorRuleBuilder.Port

Returns the Object Selection for Global Variable

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

Getter Method

Signature Port

Returns:
Return type:NXOpen.AME.SelectAMEBaseNode

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

RuleName

OperatorRuleBuilder.RuleName

Returns or sets the rule name

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

Getter Method

Signature RuleName

Returns:
Return type:str

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature RuleName

Parameters:ruleName (str) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

CreateParameter

OperatorRuleBuilder.CreateParameter

Create new parameter

Signature CreateParameter(parameterType, atIndex)

Parameters:
Returns:
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

DeleteParameter

OperatorRuleBuilder.DeleteParameter

Deletes parameter

Signature DeleteParameter(parameterType, index)

Parameters:

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

MoveParameter

OperatorRuleBuilder.MoveParameter

Move existing parameter

Signature MoveParameter(parameterType, moveFromIndex, moveToIndex)

Parameters:

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

UpdateParameter

OperatorRuleBuilder.UpdateParameter

Update existing parameter

Signature UpdateParameter(parameterType, index)

Parameters:
Returns:
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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