CallMethodRuleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CallMethodRuleBuilder Class

class `NXOpen.AME.``CallMethodRuleBuilder`

  Bases: `NXOpen.Builder`

  JA class for the call method rule dialog

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

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
Conditions | Returns the object condition ui block
CurrentParameterRuleType | Returns or sets the rule type of selected parameter
IterativeMethodSelectionType | Returns or sets the iterative method selection type
IterativeObjectConnection | Returns the iterative object connection block
IterativeSelectedPort | Returns the eo any port selection
ObjectConnection | Returns the object connection ui block
ObjectConnectionDetail | Returns the object connection detail ui block
ParameterObjectConnection | Returns the parameter object connection ui block
ParameterText | Returns or sets the constantText of a parameter
RuleCreationType | Returns or sets the creation type by creating a position
RuleName | Returns or sets the rule name
SelectionPort | Returns the 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.
RefreshContent | Update the builder of the reuse blocks
RefreshParameterDetail | Refresh the content of the detail builder
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateAllParameters | Update the selected parameter list
UpdateSelectedParameter | Update the selected parameter
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

CallMethodRuleBuilderCreationType Enumeration | replace or insert rule Type

# Property Detail

## Conditions

`CallMethodRuleBuilder.``Conditions`

  Returns the object condition ui 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”)

## CurrentParameterRuleType

`CallMethodRuleBuilder.``CurrentParameterRuleType`

  Returns or sets the rule type of selected parameter

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

  Getter Method

  Signature `CurrentParameterRuleType`

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

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `CurrentParameterRuleType`

  Parameters: | ruleType (`NXOpen.AME.PlcRuleType`) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## IterativeMethodSelectionType

`CallMethodRuleBuilder.``IterativeMethodSelectionType`

  Returns or sets the iterative method selection type

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

  Getter Method

  Signature `IterativeMethodSelectionType`

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

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `IterativeMethodSelectionType`

  Parameters: | type (`NXOpen.AME.CallMethodRuleBuilderCreationType`) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## IterativeObjectConnection

`CallMethodRuleBuilder.``IterativeObjectConnection`

  Returns the iterative object connection block

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

  Getter Method

  Signature `IterativeObjectConnection`

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

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## IterativeSelectedPort

`CallMethodRuleBuilder.``IterativeSelectedPort`

  Returns the eo any port selection

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

  Getter Method

  Signature `IterativeSelectedPort`

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

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## ObjectConnection

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

`CallMethodRuleBuilder.``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”)

## ParameterObjectConnection

`CallMethodRuleBuilder.``ParameterObjectConnection`

  Returns the parameter object connection ui block

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

  Getter Method

  Signature `ParameterObjectConnection`

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

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## ParameterText

`CallMethodRuleBuilder.``ParameterText`

  Returns or sets the constantText of a parameter

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

  Getter Method

  Signature `ParameterText`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `ParameterText`

  Parameters: | resultText (str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## RuleCreationType

`CallMethodRuleBuilder.``RuleCreationType`

  Returns or sets the creation type by creating a position

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

  Getter Method

  Signature `RuleCreationType`

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

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `RuleCreationType`

  Parameters: | type (`NXOpen.AME.CallMethodRuleBuilderCreationType`) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## RuleName

`CallMethodRuleBuilder.``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: | resultText (str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SelectionPort

`CallMethodRuleBuilder.``SelectionPort`

  Returns the replacement port selection

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

  Getter Method

  Signature `SelectionPort`

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

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

# Method Detail

## RefreshContent

`CallMethodRuleBuilder.``RefreshContent`

  Update the builder of the reuse blocks

  Signature `RefreshContent(paramOwnerId, paramName)`

  Parameters:

  - paramOwnerId (str) –
  - paramName (str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## RefreshParameterDetail

`CallMethodRuleBuilder.``RefreshParameterDetail`

  Refresh the content of the detail builder

  Signature `RefreshParameterDetail()`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## UpdateAllParameters

`CallMethodRuleBuilder.``UpdateAllParameters`

  Update the selected parameter list

  Signature `UpdateAllParameters()`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## UpdateSelectedParameter

`CallMethodRuleBuilder.``UpdateSelectedParameter`

  Update the selected parameter

  Signature `UpdateSelectedParameter(paramOwnerId, paramName)`

  Parameters:

  - paramOwnerId (str) –
  - paramName (str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Validate

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