CompareRunsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CompareRunsBuilder Class

class `NXOpen.Routing.``CompareRunsBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Routing.CompareRunsBuilder`, used to compare runs in the work part to the ones in another part, or to runs defined in xml files gathered in a folder (native mode) or on an item revision (managed mode).

  To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateCompareRunsBuilder()`

  Default values.

  Property | Value
  --- | ---
  CompareTypesEnum | Xml

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
CompareTypesEnum | Returns or sets the Compare type: part or xml
FilterString | Returns or sets the filter used to limit which runs are compared among those in the folder or on the item revision
InputPathString | Returns or sets the full path input to the compare runs algorithm.
ReportDiscrepancies | Returns or sets the option to report discrepancies down to attribute level.
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

CompareRunsBuilderCompareTypes Enumeration | The Compare Type selection Enum.

# Property Detail

## CompareTypesEnum

`CompareRunsBuilder.``CompareTypesEnum`

  Returns or sets the Compare type: part or xml

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

  Getter Method

  Signature `CompareTypesEnum`

  Returns: |
  Return type: | `NXOpen.Routing.CompareRunsBuilderCompareTypes`

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

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

  Setter Method

  Signature `CompareTypesEnum`

  Parameters: | compareTypesEnum (`NXOpen.Routing.CompareRunsBuilderCompareTypes`) –

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

## FilterString

`CompareRunsBuilder.``FilterString`

  Returns or sets the filter used to limit which runs are compared among those in the folder or on the item revision

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

  Getter Method

  Signature `FilterString`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

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

  Setter Method

  Signature `FilterString`

  Parameters: | filterString (str) –

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

## InputPathString

`CompareRunsBuilder.``InputPathString`

  Returns or sets the full path input to the compare runs algorithm.

  Can be a folder or an item revision for xml comparisons, or a part.

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

  Getter Method

  Signature `InputPathString`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

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

  Setter Method

  Signature `InputPathString`

  Parameters: | filename (str) –

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

## ReportDiscrepancies

`CompareRunsBuilder.``ReportDiscrepancies`

  Returns or sets the option to report discrepancies down to attribute level.

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

  Getter Method

  Signature `ReportDiscrepancies`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

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

  Setter Method

  Signature `ReportDiscrepancies`

  Parameters: | reportDiscrepancies (bool) –

  New in version NX9.0.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

# Method Detail

## Validate

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