The RoutingElectrical object stores a set of route electrical preferences. More...

Inheritance diagram for NXOpen.Preferences.RoutingElectrical:

Public Types
enum	ComponentMatchType { FileName, ComponentName, AttributeName }
	Manual/Auto Assign component uses the component match method to determine which component(s) are candidates for assignment to a component list record. More...

enum	CreateTerminalsType { All, Listed, Routed }
	How to create terminal segments (if creating terminal segments). More...

Public Member Functions
unsafe string	GetComponentMatchColumnHeading ()
	Gets the column name of the component list used for component matching if the method is attribute matching. More...

unsafe string	GetComponentMatchComponentAttributeTitle ()
	Gets the component attribute name used for component matching if the method is attribute matching. More...

unsafe string	GetDefaultHarnessName ()
	Gets the default harness name. More...

unsafe string	GetFilterBlankingAttribute ()
	Gets the Rlist_Filter_Blanking_Attribute. More...

unsafe string	GetFilterFormatFileName ()
	Gets the file name for the stand alone XML filters and formats file. More...

unsafe string[]	GetFormboardFrameSizes ()
	Gets the formboard frame sizes currently specified within the Routing Electrical application. More...

unsafe void	SetComponentMatchColumnHeading (string columnHeading)
	Sets the column name of the component list used for component matching if the method is attribute matching. More...

unsafe void	SetComponentMatchComponentAttributeTitle (string componentAttributeTitle)
	Sets the component attribute name used for component matching if the method is attribute matching. More...

unsafe void	SetDefaultHarnessName (string defaultHarnessName)
	Sets the default harness name More...

unsafe void	SetFilterBlankingAttribute (string attributeName)
	Sets the Rlist_Filter_Blanking_Attribute. More...

unsafe void	SetFilterFormatFileName (string filterFormatFileName)
	Sets the file name for the stand alone XML filters and formats file. More...

unsafe void	SetFormboardFrameSizes (string[] frameSizes)
	Sets a formboard frame size. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe bool	AutomaticRouteLevel `[get, set]`
	Returns or sets the level at which to automatically route a path. More...

unsafe NXOpen.Routing.StockStyle	AutoRouteStockStyle `[get, set]`
	Returns or sets the option to Auto Route using centerline stock style (i. More...

unsafe int	BundleColor `[get, set]`
	Returns or sets the default bundle color. More...

unsafe NXOpen.Preferences.RoutingElectrical.ComponentMatchType	ComponentMatchMethod `[get, set]`
	Returns or sets the component match option for automatic/manual component assignment. More...

unsafe NXOpen.Preferences.RoutingElectrical.CreateTerminalsType	CreateTerminalsOption `[get, set]`
	Returns or sets the create terminals option. More...

unsafe string	DefaultJumperLength `[get, set]`
	Returns or sets the default length of a jumper wire. More...

unsafe bool	ExportFormatInLegacyFile `[get, set]`
	Returns or sets the option to export the format at the top of a legacy routelist file. More...

unsafe double	FormboardSynchronizationLengthTolerance `[get, set]`
	Returns or sets the default segment length tolerance to use for Formboard Synchronization. More...

unsafe bool	HighlightWire `[get, set]`
	Returns or sets the option to highlight a wire in the connection list navigator. More...

unsafe bool	RecordNetlistHistory `[get, set]`
	Returns or sets the option to record import and export activity in the Connection and Component Lists. More...

unsafe bool	ReportRouteErrors `[get, set]`
	Returns or sets the option to report auto/manual route errors to the listing window. More...

unsafe bool	StandaloneFilterFormatFile `[get, set]`
	Returns or sets the option to export the XML routelist data with the formats and filters information separately. More...

Tag	Tag `[get]`
	Returns the tag of this object. More...

unsafe bool	TerminalSegmentSolidDisplay `[get, set]`
	Returns or sets the terminal segment solid display option More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Detailed Description

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

Created in NX4.0.0

Member Enumeration Documentation

enum NXOpen.Preferences.RoutingElectrical.ComponentMatchType

Manual/Auto Assign component uses the component match method to determine which component(s) are candidates for assignment to a component list record.

Matching consists of matching the: o the file name of a component o the component name o Part Name field of the component list record to an attribute

If attribute name matching is specified, indicate the name of the attribute.

Enumerator
FileName	Match file name during component assignment.
ComponentName	Match component name during component assignment.
AttributeName	Match attribute name during component assignment.

enum NXOpen.Preferences.RoutingElectrical.CreateTerminalsType

How to create terminal segments (if creating terminal segments).

Enumerator
All	Create terminals to all terminals
Listed	Create terminals to listed terminals
Routed	Create terminals to routed terminals

Member Function Documentation

unsafe string NXOpen.Preferences.RoutingElectrical.GetComponentMatchColumnHeading ( )

inline

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

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe string NXOpen.Preferences.RoutingElectrical.GetComponentMatchComponentAttributeTitle ( )

inline

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

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe string NXOpen.Preferences.RoutingElectrical.GetDefaultHarnessName ( )

inline

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.

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe string NXOpen.Preferences.RoutingElectrical.GetFilterBlankingAttribute ( )

inline

Gets the Rlist_Filter_Blanking_Attribute.

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe string NXOpen.Preferences.RoutingElectrical.GetFilterFormatFileName ( )

inline

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

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe string [] NXOpen.Preferences.RoutingElectrical.GetFormboardFrameSizes ( )

inline

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)

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe void NXOpen.Preferences.RoutingElectrical.SetComponentMatchColumnHeading ( string columnHeading )

inline

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

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

columnHeading

unsafe void NXOpen.Preferences.RoutingElectrical.SetComponentMatchComponentAttributeTitle ( string componentAttributeTitle )

inline

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

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

componentAttributeTitle

unsafe void NXOpen.Preferences.RoutingElectrical.SetDefaultHarnessName ( string defaultHarnessName )

inline

Sets the default harness name

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

defaultHarnessName

unsafe void NXOpen.Preferences.RoutingElectrical.SetFilterBlankingAttribute ( string attributeName )

inline

Sets the Rlist_Filter_Blanking_Attribute.

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

attributeName

unsafe void NXOpen.Preferences.RoutingElectrical.SetFilterFormatFileName ( string filterFormatFileName )

inline

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

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

filterFormatFileName

unsafe void NXOpen.Preferences.RoutingElectrical.SetFormboardFrameSizes ( string[] frameSizes )

inline

Sets a formboard frame size.

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

frameSizes

Property Documentation

unsafe bool NXOpen.Preferences.RoutingElectrical.AutomaticRouteLevel

getset

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

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe NXOpen.Routing.StockStyle NXOpen.Preferences.RoutingElectrical.AutoRouteStockStyle

getset

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

e. none) or simple stock style.

Created in NX6.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe int NXOpen.Preferences.RoutingElectrical.BundleColor

getset

Returns or sets the default bundle color.

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe NXOpen.Preferences.RoutingElectrical.ComponentMatchType NXOpen.Preferences.RoutingElectrical.ComponentMatchMethod

getset

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

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe NXOpen.Preferences.RoutingElectrical.CreateTerminalsType NXOpen.Preferences.RoutingElectrical.CreateTerminalsOption

getset

Returns or sets the create terminals option.

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingElectrical.DefaultJumperLength

getset

Returns or sets the default length of a jumper wire.

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe bool NXOpen.Preferences.RoutingElectrical.ExportFormatInLegacyFile

getset

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

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe double NXOpen.Preferences.RoutingElectrical.FormboardSynchronizationLengthTolerance

getset

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

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe bool NXOpen.Preferences.RoutingElectrical.HighlightWire

getset

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

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe bool NXOpen.Preferences.RoutingElectrical.RecordNetlistHistory

getset

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

Created in NX6.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe bool NXOpen.Preferences.RoutingElectrical.ReportRouteErrors

getset

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

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe bool NXOpen.Preferences.RoutingElectrical.StandaloneFilterFormatFile

getset

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

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Tag NXOpen.Preferences.RoutingElectrical.Tag

get

Returns the tag of this object.

unsafe bool NXOpen.Preferences.RoutingElectrical.TerminalSegmentSolidDisplay

getset

Returns or sets the terminal segment solid display option

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

The documentation for this class was generated from the following file:

Preferences_RoutingElectrical.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation