OperandRuleBuilder Class¶
-
class
NXOpen.AME.
OperandRuleBuilder
¶ Bases:
NXOpen.Builder
JA class for the parameter rule dialog
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateOperandRuleBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
Conditions | Returns the object condition ui block |
ObjectConnection | Returns the object connection ui block |
ObjectConnectionDetail | Returns the object connection detail ui block |
PortCreationType | Returns or sets the creation type when creating a position |
RuleName | Returns or sets the rule name |
SelectionPort | Returns the operand replacement 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. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
OperandRuleBuilderCreationType Enumeration | replace or insert rule Type |
Property Detail¶
Conditions¶
-
OperandRuleBuilder.
Conditions
¶ Returns the object condition ui block
-------------------------------------
Getter Method
Signature
Conditions
Returns: Return type: NXOpen.AME.ConditionsBuilder
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ObjectConnection¶
-
OperandRuleBuilder.
ObjectConnection
¶ Returns the object connection ui block
-------------------------------------
Getter Method
Signature
ObjectConnection
Returns: Return type: NXOpen.AME.ObjectConnectionBuilder
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ObjectConnectionDetail¶
-
OperandRuleBuilder.
ObjectConnectionDetail
¶ Returns the object connection detail ui block
-------------------------------------
Getter Method
Signature
ObjectConnectionDetail
Returns: Return type: NXOpen.AME.ObjectConnectionDetailBuilder
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
PortCreationType¶
-
OperandRuleBuilder.
PortCreationType
¶ Returns or sets the creation type when creating a position
-------------------------------------
Getter Method
Signature
PortCreationType
Returns: Return type: NXOpen.AME.OperandRuleBuilderCreationType
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
PortCreationType
Parameters: type ( NXOpen.AME.OperandRuleBuilderCreationType
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
RuleName¶
-
OperandRuleBuilder.
RuleName
¶ Returns or sets the rule name
-------------------------------------
Getter Method
Signature
RuleName
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
RuleName
Parameters: resultText (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectionPort¶
-
OperandRuleBuilder.
SelectionPort
¶ Returns the operand replacement port selection
-------------------------------------
Getter Method
Signature
SelectionPort
Returns: Return type: NXOpen.AME.SelectAMEBaseNode
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
OperandRuleBuilder.
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.