DrawingCompareManager Class — NXOpen Python API Reference 12.0.0 documentation

# DrawingCompareManager Class

class `NXOpen.``DrawingCompareManager`

  Bases: `object`

  Represents an object that manages drawing compare.

  To obtain an instance of this class, refer to `NXOpen.Part`

  New in version NX7.5.0.

# Methods

Method | Description
--- | ---
CreateCompareReportBuilder | Creates a `NXOpen.Drawings.CompareReportBuilder`
CreateDrawingCompareSettingsBuilder | Creates a `NXOpen.Drawings.DrawingCompareSettingsBuilder`
CreateOverlayData | Creates Overlay data of a part.
CreateSnapshot | Caches data for drafting objects in the drawing part.
CreateTrackChanges | Create track changes data for drafting objects in the drawing part
DeleteComparisonReport | Deletes part comparison report.
DeleteOverlayData | Deletes Overlay data of a part.
DeleteSnapshot | Deletes the cached data for drafting objects.
DeleteTrackChanges | Delete track changes data for drafting objects in the drawing part
GetEntityObjectFromId | Gets the entity for the given ID.
PreserveChangeSymbol | Preserves the change symbol settings of the objects passed to it.
UnpreserveChangeSymbol | Unpreserves the change symbol settings of the objects passed to it.

# Method Detail

## CreateCompareReportBuilder

`DrawingCompareManager.``CreateCompareReportBuilder`

  Overloaded method CreateCompareReportBuilder

  - `CreateCompareReportBuilder()`
  - `CreateCompareReportBuilder(partFileNameToCompare, reuseExistingSnapshot)`

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

  Creates a `NXOpen.Drawings.CompareReportBuilder`

  Signature `CreateCompareReportBuilder()`

  Returns: |
  Return type: | `NXOpen.Drawings.CompareReportBuilder`

  New in version NX7.5.0.

  Deprecated since version NX11.0.0: Use `DrawingCompareManager.CreateCompareReportBuilder()` instead.

  License requirements: drafting (“DRAFTING”)

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

  Creates a `NXOpen.Drawings.CompareReportBuilder`

  Signature `CreateCompareReportBuilder(partFileNameToCompare, reuseExistingSnapshot)`

  Parameters:

  - partFileNameToCompare (str) –
  - reuseExistingSnapshot (bool) –

  Returns: |
  Return type: | `NXOpen.Drawings.CompareReportBuilder`

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

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

## CreateDrawingCompareSettingsBuilder

`DrawingCompareManager.``CreateDrawingCompareSettingsBuilder`

  Creates a `NXOpen.Drawings.DrawingCompareSettingsBuilder`

  Signature `CreateDrawingCompareSettingsBuilder()`

  Returns: |
  Return type: | `NXOpen.Drawings.DrawingCompareSettingsBuilder`

  New in version NX7.5.0.

  License requirements: drafting (“DRAFTING”)

## CreateOverlayData

`DrawingCompareManager.``CreateOverlayData`

  Creates Overlay data of a part.

  Signature `CreateOverlayData()`

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## CreateSnapshot

`DrawingCompareManager.``CreateSnapshot`

  Caches data for drafting objects in the drawing part.

  Creates overlay data if the status of toggle “Create Overlay Data with Snapshot Data” in Customer Default is on. Use `DrawingCompareManager.CreateOverlayData()` to create overlay data.

  Signature `CreateSnapshot()`

  New in version NX7.5.0.

  License requirements: None.

## CreateTrackChanges

`DrawingCompareManager.``CreateTrackChanges`

  Create track changes data for drafting objects in the drawing part

  Signature `CreateTrackChanges()`

  New in version NX7.5.0.

  License requirements: None.

## DeleteComparisonReport

`DrawingCompareManager.``DeleteComparisonReport`

  Deletes part comparison report.

  Signature `DeleteComparisonReport()`

  New in version NX7.5.0.

  License requirements: None.

## DeleteOverlayData

`DrawingCompareManager.``DeleteOverlayData`

  Deletes Overlay data of a part.

  Signature `DeleteOverlayData()`

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## DeleteSnapshot

`DrawingCompareManager.``DeleteSnapshot`

  Deletes the cached data for drafting objects.

  Does not delete the overlay data. Use `DrawingCompareManager.DeleteOverlayData()` to delete overlay data.

  Signature `DeleteSnapshot()`

  New in version NX7.5.0.

  License requirements: None.

## DeleteTrackChanges

`DrawingCompareManager.``DeleteTrackChanges`

  Delete track changes data for drafting objects in the drawing part

  Signature `DeleteTrackChanges()`

  New in version NX7.5.0.

  License requirements: None.

## GetEntityObjectFromId

`DrawingCompareManager.``GetEntityObjectFromId`

  Gets the entity for the given ID.

  Signature `GetEntityObjectFromId(subfileID)`

  Parameters: | subfileID (int) – The ID of entity
  Returns: | The object of entity
  Return type: | `NXOpen.NXObject`

  New in version NX7.5.0.

  License requirements: None.

## PreserveChangeSymbol

`DrawingCompareManager.``PreserveChangeSymbol`

  Preserves the change symbol settings of the objects passed to it.

  Signature `PreserveChangeSymbol(idSymbols)`

  Parameters: | idSymbols (list of `NXOpen.Annotations.IdSymbol`) – a list of change symbols

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## UnpreserveChangeSymbol

`DrawingCompareManager.``UnpreserveChangeSymbol`

  Unpreserves the change symbol settings of the objects passed to it.

  Signature `UnpreserveChangeSymbol(idSymbols)`

  Parameters: | idSymbols (list of `NXOpen.Annotations.IdSymbol`) – a list of change symbols

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)