RoutingElectrical Class — NXOpen Python API Reference 12.0.0 documentation

# RoutingElectrical Class

class `NXOpen.Preferences.``RoutingElectrical`

  Bases: `object`

  The RoutingElectrical object stores a set of route electrical preferences.

  A valid application view file is necessary to get values other than defaults for the electrical preferences. To obtain an instance of this class, refer to `NXOpen.Preferences.RoutingApplicationView`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
AutoRouteStockStyle | Returns or sets the option to Auto Route using centerline stock style (i.
AutomaticRouteLevel | Returns or sets the level at which to automatically route a path.
BundleColor | Returns or sets the default bundle color.
ComponentMatchMethod | Returns or sets the component match option for automatic/manual component assignment.
CreateTerminalsOption | Returns or sets the create terminals option.
DefaultJumperLength | Returns or sets the default length of a jumper wire.
ExportFormatInLegacyFile | Returns or sets the option to export the format at the top of a legacy routelist file.
FormboardSynchronizationLengthTolerance | Returns or sets the default segment length tolerance to use for Formboard Synchronization.
HighlightWire | Returns or sets the option to highlight a wire in the connection list navigator.
RecordNetlistHistory | Returns or sets the option to record import and export activity in the Connection and Component Lists.
ReportRouteErrors | Returns or sets the option to report auto/manual route errors to the listing window.
StandaloneFilterFormatFile | Returns or sets the option to export the XML routelist data with the formats and filters information separately.
TerminalSegmentSolidDisplay | Returns or sets the terminal segment solid display option

# Methods

Method | Description
--- | ---
GetComponentMatchColumnHeading | Gets the column name of the component list used for component matching if the method is attribute matching.
GetComponentMatchComponentAttributeTitle | Gets the component attribute name used for component matching if the method is attribute matching.
GetDefaultHarnessName | Gets the default harness name.
GetFilterBlankingAttribute | Gets the Rlist_Filter_Blanking_Attribute.
GetFilterFormatFileName | Gets the file name for the stand alone XML filters and formats file.
GetFormboardFrameSizes | Gets the formboard frame sizes currently specified within the Routing Electrical application.
SetComponentMatchColumnHeading | Sets the column name of the component list used for component matching if the method is attribute matching.
SetComponentMatchComponentAttributeTitle | Sets the component attribute name used for component matching if the method is attribute matching.
SetDefaultHarnessName | Sets the default harness name
SetFilterBlankingAttribute | Sets the Rlist_Filter_Blanking_Attribute.
SetFilterFormatFileName | Sets the file name for the stand alone XML filters and formats file.
SetFormboardFrameSizes | Sets a formboard frame size.

# Enumerations

RoutingElectricalComponentMatchType Enumeration | Manual/Auto Assign component uses the component match method to determine which component(s) are candidates for assignment to a component list record.
RoutingElectricalCreateTerminalsType Enumeration | How to create terminal segments (if creating terminal segments).

# Property Detail

## AutoRouteStockStyle

`RoutingElectrical.``AutoRouteStockStyle`

  Returns or sets the option to Auto Route using centerline stock style (i.

  5. none) or simple stock style.

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

  Getter Method

  Signature `AutoRouteStockStyle`

  Returns: | Will be either `NXOpen.Routing.StockStyle.None`) or

  `NXOpen.Routing.StockStyle.Simple`). :rtype: `NXOpen.Routing.StockStyle`

  New in version NX6.0.0.

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

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

  Setter Method

  Signature `AutoRouteStockStyle`

  Parameters: | stockStyle (`NXOpen.Routing.StockStyle`) – Must be either `NXOpen.Routing.StockStyle.None`) or `NXOpen.Routing.StockStyle.Simple`).

  New in version NX6.0.0.

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

## AutomaticRouteLevel

`RoutingElectrical.``AutomaticRouteLevel`

  Returns or sets the level at which to automatically route a path.

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

  Getter Method

  Signature `AutomaticRouteLevel`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `AutomaticRouteLevel`

  Parameters: | isPinLevelRoute (bool) –

  New in version NX4.0.0.

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

## BundleColor

`RoutingElectrical.``BundleColor`

  Returns or sets the default bundle color.

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

  Getter Method

  Signature `BundleColor`

  Returns: |
  Return type: | int

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `BundleColor`

  Parameters: | bundleColor (int) –

  New in version NX4.0.0.

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

## ComponentMatchMethod

`RoutingElectrical.``ComponentMatchMethod`

  Returns or sets the component match option for automatic/manual component assignment.

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

  Getter Method

  Signature `ComponentMatchMethod`

  Returns: |
  Return type: | `NXOpen.Preferences.RoutingElectricalComponentMatchType`

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `ComponentMatchMethod`

  Parameters: | componentMatchMethod (`NXOpen.Preferences.RoutingElectricalComponentMatchType`) –

  New in version NX4.0.0.

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

## CreateTerminalsOption

`RoutingElectrical.``CreateTerminalsOption`

  Returns or sets the create terminals option.

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

  Getter Method

  Signature `CreateTerminalsOption`

  Returns: |
  Return type: | `NXOpen.Preferences.RoutingElectricalCreateTerminalsType`

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `CreateTerminalsOption`

  Parameters: | createTerminalsOption (`NXOpen.Preferences.RoutingElectricalCreateTerminalsType`) –

  New in version NX4.0.0.

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

## DefaultJumperLength

`RoutingElectrical.``DefaultJumperLength`

  Returns or sets the default length of a jumper wire.

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

  Getter Method

  Signature `DefaultJumperLength`

  Returns: |
  Return type: | str

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `DefaultJumperLength`

  Parameters: | defaultJumperLength (str) –

  New in version NX4.0.0.

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

## ExportFormatInLegacyFile

`RoutingElectrical.``ExportFormatInLegacyFile`

  Returns or sets the option to export the format at the top of a legacy routelist file.

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

  Getter Method

  Signature `ExportFormatInLegacyFile`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `ExportFormatInLegacyFile`

  Parameters: | exportFormat (bool) –

  New in version NX4.0.0.

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

## FormboardSynchronizationLengthTolerance

`RoutingElectrical.``FormboardSynchronizationLengthTolerance`

  Returns or sets the default segment length tolerance to use for Formboard Synchronization.

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

  Getter Method

  Signature `FormboardSynchronizationLengthTolerance`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `FormboardSynchronizationLengthTolerance`

  Parameters: | segmentLengthTolerance (float) –

  New in version NX4.0.0.

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

## HighlightWire

`RoutingElectrical.``HighlightWire`

  Returns or sets the option to highlight a wire in the connection list navigator.

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

  Getter Method

  Signature `HighlightWire`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `HighlightWire`

  Parameters: | highlightWire (bool) –

  New in version NX4.0.0.

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

## RecordNetlistHistory

`RoutingElectrical.``RecordNetlistHistory`

  Returns or sets the option to record import and export activity in the Connection and Component Lists.

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

  Getter Method

  Signature `RecordNetlistHistory`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

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

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

  Setter Method

  Signature `RecordNetlistHistory`

  Parameters: | recordNetlistHistory (bool) – Should Routing record the netlist history?

  New in version NX6.0.0.

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

## ReportRouteErrors

`RoutingElectrical.``ReportRouteErrors`

  Returns or sets the option to report auto/manual route errors to the listing window.

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

  Getter Method

  Signature `ReportRouteErrors`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `ReportRouteErrors`

  Parameters: | reportRouteErrors (bool) –

  New in version NX4.0.0.

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

## StandaloneFilterFormatFile

`RoutingElectrical.``StandaloneFilterFormatFile`

  Returns or sets the option to export the XML routelist data with the formats and filters information separately.

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

  Getter Method

  Signature `StandaloneFilterFormatFile`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `StandaloneFilterFormatFile`

  Parameters: | standaloneFilterFormatFile (bool) –

  New in version NX4.0.0.

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

## TerminalSegmentSolidDisplay

`RoutingElectrical.``TerminalSegmentSolidDisplay`

  Returns or sets the terminal segment solid display option

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

  Getter Method

  Signature `TerminalSegmentSolidDisplay`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

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

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

  Setter Method

  Signature `TerminalSegmentSolidDisplay`

  Parameters: | terminalSegmentSolid (bool) –

  New in version NX4.0.0.

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

# Method Detail

## GetComponentMatchColumnHeading

`RoutingElectrical.``GetComponentMatchColumnHeading`

  Gets the column name of the component list used for component matching if the method is attribute matching.

  Signature `GetComponentMatchColumnHeading()`

  Returns: |
  Return type: | str

  New in version NX4.0.0.

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

## GetComponentMatchComponentAttributeTitle

`RoutingElectrical.``GetComponentMatchComponentAttributeTitle`

  Gets the component attribute name used for component matching if the method is attribute matching.

  Signature `GetComponentMatchComponentAttributeTitle()`

  Returns: |
  Return type: | str

  New in version NX4.0.0.

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

## GetDefaultHarnessName

`RoutingElectrical.``GetDefaultHarnessName`

  Gets the default harness name.

  The default harness name replaces the Harness field value of any records in an imported connection/component list that are empty. A blank string in the Default_Harness_Name element below replaces blank Harness fields with the leaf name of the work part.

  Signature `GetDefaultHarnessName()`

  Returns: |
  Return type: | str

  New in version NX4.0.0.

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

## GetFilterBlankingAttribute

`RoutingElectrical.``GetFilterBlankingAttribute`

  Gets the Rlist_Filter_Blanking_Attribute.

  Signature `GetFilterBlankingAttribute()`

  Returns: |
  Return type: | str

  New in version NX4.0.0.

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

## GetFilterFormatFileName

`RoutingElectrical.``GetFilterFormatFileName`

  Gets the file name for the stand alone XML filters and formats file.

  Signature `GetFilterFormatFileName()`

  Returns: |
  Return type: | str

  New in version NX4.0.0.

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

## GetFormboardFrameSizes

`RoutingElectrical.``GetFormboardFrameSizes`

  Gets the formboard frame sizes currently specified within the Routing Electrical application.

  Formboard frame sizes are character strings are of the form Height x Length (units).

  Units can be “in” or “mm” (case insensitive).

  The Height, Length and units fields of the string are separated by one of the following separator characters:

  “x”, “X”, any whitespace, “:” (colon), or a “,” (comma)

  Signature `GetFormboardFrameSizes()`

  Returns: |
  Return type: | list of str

  New in version NX4.0.0.

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

## SetComponentMatchColumnHeading

`RoutingElectrical.``SetComponentMatchColumnHeading`

  Sets the column name of the component list used for component matching if the method is attribute matching.

  Signature `SetComponentMatchColumnHeading(columnHeading)`

  Parameters: | columnHeading (str) –

  New in version NX4.0.0.

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

## SetComponentMatchComponentAttributeTitle

`RoutingElectrical.``SetComponentMatchComponentAttributeTitle`

  Sets the component attribute name used for component matching if the method is attribute matching.

  Signature `SetComponentMatchComponentAttributeTitle(componentAttributeTitle)`

  Parameters: | componentAttributeTitle (str) –

  New in version NX4.0.0.

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

## SetDefaultHarnessName

`RoutingElectrical.``SetDefaultHarnessName`

  Sets the default harness name

  Signature `SetDefaultHarnessName(defaultHarnessName)`

  Parameters: | defaultHarnessName (str) –

  New in version NX4.0.0.

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

## SetFilterBlankingAttribute

`RoutingElectrical.``SetFilterBlankingAttribute`

  Sets the Rlist_Filter_Blanking_Attribute.

  Signature `SetFilterBlankingAttribute(attributeName)`

  Parameters: | attributeName (str) –

  New in version NX4.0.0.

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

## SetFilterFormatFileName

`RoutingElectrical.``SetFilterFormatFileName`

  Sets the file name for the stand alone XML filters and formats file.

  Signature `SetFilterFormatFileName(filterFormatFileName)`

  Parameters: | filterFormatFileName (str) –

  New in version NX4.0.0.

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

## SetFormboardFrameSizes

`RoutingElectrical.``SetFormboardFrameSizes`

  Sets a formboard frame size.

  Signature `SetFormboardFrameSizes(frameSizes)`

  Parameters: | frameSizes (list of str) –

  New in version NX4.0.0.

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