DesignRuleViolationViewer Class — NXOpen Python API Reference 12.0.0 documentation

# DesignRuleViolationViewer Class

class `NXOpen.Routing.``DesignRuleViolationViewer`

  Bases: `NXOpen.Builder`

  This class can be used to set the violation id, update text for overridding the violation and update the user name used to override the violation.

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

  Default values.

  Property | Value
  --- | ---
  DialogViolationId | 0
  FilterOptionValue | AllViolations
  NavigateViolationLocationOption | true
  OverrideOptionValue | No

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
DialogViolationId | Returns or sets the dialog design rule violation Id
FilterOptionValue | Returns or sets the value for filter option of route Design Rule Violation
NavigateViolationLocationOption | Returns or sets the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations.
OverrideOptionValue | Returns or sets the value for design Rule Violation override option if Yes: violation is overridden if No: violation is not overridden
Tag | Returns the Tag for this object.
Username | Returns or sets the username who has overridden design Rule violation

# 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.
GetOverrideText | Returns the text written as a reason for overriding the violation
SetOverrideText | Sets the text for reason of overriding the violation
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

DesignRuleViolationViewerFilterOption Enumeration | Enumerations to show options for filter.
DesignRuleViolationViewerOverrideOption Enumeration | Enumerations to show options for override

# Property Detail

## DialogViolationId

`DesignRuleViolationViewer.``DialogViolationId`

  Returns or sets the dialog design rule violation Id

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

  Getter Method

  Signature `DialogViolationId`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

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

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

  Setter Method

  Signature `DialogViolationId`

  Parameters: | dialogViolationID (int) –

  New in version NX6.0.0.

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

## FilterOptionValue

`DesignRuleViolationViewer.``FilterOptionValue`

  Returns or sets the value for filter option of route Design Rule Violation

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

  Getter Method

  Signature `FilterOptionValue`

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

  New in version NX6.0.0.

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

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

  Setter Method

  Signature `FilterOptionValue`

  Parameters: | filterOptionValue (`NXOpen.Routing.DesignRuleViolationViewerFilterOption`) –

  New in version NX6.0.0.

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

## NavigateViolationLocationOption

`DesignRuleViolationViewer.``NavigateViolationLocationOption`

  Returns or sets the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations.

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

  Getter Method

  Signature `NavigateViolationLocationOption`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

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

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

  Setter Method

  Signature `NavigateViolationLocationOption`

  Parameters: | navigateViolationLocationOption (bool) –

  New in version NX6.0.0.

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

## OverrideOptionValue

`DesignRuleViolationViewer.``OverrideOptionValue`

  Returns or sets the value for design Rule Violation override option if Yes: violation is overridden if No: violation is not overridden

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

  Getter Method

  Signature `OverrideOptionValue`

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

  New in version NX6.0.0.

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

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

  Setter Method

  Signature `OverrideOptionValue`

  Parameters: | overrideOptionValue (`NXOpen.Routing.DesignRuleViolationViewerOverrideOption`) –

  New in version NX6.0.0.

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

## Username

`DesignRuleViolationViewer.``Username`

  Returns or sets the username who has overridden design Rule violation

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

  Getter Method

  Signature `Username`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

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

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

  Setter Method

  Signature `Username`

  Parameters: | username (str) –

  New in version NX6.0.0.

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

# Method Detail

## GetOverrideText

`DesignRuleViolationViewer.``GetOverrideText`

  Returns the text written as a reason for overriding the violation

  Signature `GetOverrideText()`

  Returns: |
  Return type: | list of str

  New in version NX6.0.0.

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

## SetOverrideText

`DesignRuleViolationViewer.``SetOverrideText`

  Sets the text for reason of overriding the violation

  Signature `SetOverrideText(overrideText)`

  Parameters: | overrideText (list of str) –

  New in version NX6.0.0.

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

## Validate

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