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

Public Types
enum	ComponentMatchType { ComponentMatchTypeFileName, ComponentMatchTypeComponentName, ComponentMatchTypeAttributeName }
	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 { CreateTerminalsTypeAll, CreateTerminalsTypeListed, CreateTerminalsTypeRouted }
	How to create terminal segments (if creating terminal segments). More...

Public Member Functions
bool	AutomaticRouteLevel ()
	Returns the level at which to automatically route a path.

NXOpen::Routing::StockStyle	AutoRouteStockStyle ()
	Returns the option to Auto Route using centerline stock style (i.e.

int	BundleColor ()
	Returns the default bundle color.

NXOpen::Preferences::RoutingElectrical::ComponentMatchType	ComponentMatchMethod ()
	Returns the component match option for automatic/manual component assignment.

NXOpen::Preferences::RoutingElectrical::CreateTerminalsType	CreateTerminalsOption ()
	Returns the create terminals option.

NXString	DefaultJumperLength ()
	Returns the default length of a jumper wire.

bool	ExportFormatInLegacyFile ()
	Returns the option to export the format at the top of a legacy routelist file.

double	FormboardSynchronizationLengthTolerance ()
	Returns the default segment length tolerance to use for Formboard Synchronization.

NXString	GetComponentMatchColumnHeading ()
	Gets the column name of the component list used for component matching if the method is attribute matching.

NXString	GetComponentMatchComponentAttributeTitle ()
	Gets the component attribute name used for component matching if the method is attribute matching.

NXString	GetDefaultHarnessName ()
	Gets the default harness name.

NXString	GetFilterBlankingAttribute ()
	Gets the Rlist_Filter_Blanking_Attribute.

NXString	GetFilterFormatFileName ()
	Gets the file name for the stand alone XML filters and formats file.

std::vector< NXString >	GetFormboardFrameSizes ()
	Gets the formboard frame sizes currently specified within the Routing Electrical application.

bool	HighlightWire ()
	Returns the option to highlight a wire in the connection list navigator.

bool	RecordNetlistHistory ()
	Returns the option to record import and export activity in the Connection and Component Lists.

bool	ReportRouteErrors ()
	Returns the option to report auto/manual route errors to the listing window.

void	SetAutomaticRouteLevel (bool isPinLevelRoute)
	Sets the level at which to automatically route a path.

void	SetAutoRouteStockStyle (NXOpen::Routing::StockStyle stockStyle)
	Sets the option to Auto Route using centerline stock style (i.e.

void	SetBundleColor (int bundleColor)
	Sets the default bundle color.

void	SetComponentMatchColumnHeading (const NXString &columnHeading)
	Sets the column name of the component list used for component matching if the method is attribute matching.

void	SetComponentMatchColumnHeading (const char *columnHeading)
	Sets the column name of the component list used for component matching if the method is attribute matching.

void	SetComponentMatchComponentAttributeTitle (const NXString &componentAttributeTitle)
	Sets the component attribute name used for component matching if the method is attribute matching.

void	SetComponentMatchComponentAttributeTitle (const char *componentAttributeTitle)
	Sets the component attribute name used for component matching if the method is attribute matching.

void	SetComponentMatchMethod (NXOpen::Preferences::RoutingElectrical::ComponentMatchType componentMatchMethod)
	Sets the component match option for automatic/manual component assignment.

void	SetCreateTerminalsOption (NXOpen::Preferences::RoutingElectrical::CreateTerminalsType createTerminalsOption)
	Sets the create terminals option.

void	SetDefaultHarnessName (const NXString &defaultHarnessName)
	Sets the default harness name Created in NX4.0.0.

void	SetDefaultHarnessName (const char *defaultHarnessName)
	Sets the default harness name Created in NX4.0.0.

void	SetDefaultJumperLength (const NXString &defaultJumperLength)
	Sets the default length of a jumper wire.

void	SetDefaultJumperLength (const char *defaultJumperLength)
	Sets the default length of a jumper wire.

void	SetExportFormatInLegacyFile (bool exportFormat)
	Sets the option to export the format at the top of a legacy routelist file.

void	SetFilterBlankingAttribute (const NXString &attributeName)
	Sets the Rlist_Filter_Blanking_Attribute.

void	SetFilterBlankingAttribute (const char *attributeName)
	Sets the Rlist_Filter_Blanking_Attribute.

void	SetFilterFormatFileName (const NXString &filterFormatFileName)
	Sets the file name for the stand alone XML filters and formats file.

void	SetFilterFormatFileName (const char *filterFormatFileName)
	Sets the file name for the stand alone XML filters and formats file.

void	SetFormboardFrameSizes (std::vector< NXString > &frameSizes)
	Sets a formboard frame size.

void	SetFormboardSynchronizationLengthTolerance (double segmentLengthTolerance)
	Sets the default segment length tolerance to use for Formboard Synchronization.

void	SetHighlightWire (bool highlightWire)
	Sets the option to highlight a wire in the connection list navigator.

void	SetRecordNetlistHistory (bool recordNetlistHistory)
	Sets the option to record import and export activity in the Connection and Component Lists.

void	SetReportRouteErrors (bool reportRouteErrors)
	Sets the option to report auto/manual route errors to the listing window.

void	SetStandaloneFilterFormatFile (bool standaloneFilterFormatFile)
	Sets the option to export the XML routelist data with the formats and filters information separately.

void	SetTerminalSegmentSolidDisplay (bool terminalSegmentSolid)
	Sets the terminal segment solid display option Created in NX4.0.0.

bool	StandaloneFilterFormatFile ()
	Returns the option to export the XML routelist data with the formats and filters information separately.

tag_t	Tag () const
	Returns the tag of this object.

bool	TerminalSegmentSolidDisplay ()
	Returns the terminal segment solid display option Created in NX4.0.0.

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 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:

ComponentMatchTypeFileName	Match file name during component assignment.
ComponentMatchTypeComponentName	Match component name during component assignment.
ComponentMatchTypeAttributeName	Match attribute name during component assignment.

enum NXOpen::Preferences::RoutingElectrical::CreateTerminalsType

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

Enumerator:

CreateTerminalsTypeAll	Create terminals to all terminals.
CreateTerminalsTypeListed	Create terminals to listed terminals.
CreateTerminalsTypeRouted	Create terminals to routed terminals.

Member Function Documentation

bool NXOpen::Preferences::RoutingElectrical::AutomaticRouteLevel ( )

Returns the level at which to automatically route a path.

Created in NX4.0.0.

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

NXOpen::Routing::StockStyle NXOpen::Preferences::RoutingElectrical::AutoRouteStockStyle ( )

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

none) or simple stock style.
Created in NX6.0.0.

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

int NXOpen::Preferences::RoutingElectrical::BundleColor ( )

Returns the default bundle color.

Created in NX4.0.0.

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

NXOpen::Preferences::RoutingElectrical::ComponentMatchType NXOpen::Preferences::RoutingElectrical::ComponentMatchMethod ( )

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

Created in NX4.0.0.

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

NXOpen::Preferences::RoutingElectrical::CreateTerminalsType NXOpen::Preferences::RoutingElectrical::CreateTerminalsOption ( )

Returns the create terminals option.

Created in NX4.0.0.

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

NXString NXOpen::Preferences::RoutingElectrical::DefaultJumperLength ( )

Returns the default length of a jumper wire.

Created in NX4.0.0.

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

bool NXOpen::Preferences::RoutingElectrical::ExportFormatInLegacyFile ( )

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

Created in NX4.0.0.

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

double NXOpen::Preferences::RoutingElectrical::FormboardSynchronizationLengthTolerance ( )

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

Created in NX4.0.0.

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

NXString NXOpen::Preferences::RoutingElectrical::GetComponentMatchColumnHeading ( )

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

Returns: Created in NX4.0.0.

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

NXString NXOpen::Preferences::RoutingElectrical::GetComponentMatchComponentAttributeTitle ( )

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

Returns: Created in NX4.0.0.

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

NXString NXOpen::Preferences::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.

Returns: Created in NX4.0.0.

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

NXString NXOpen::Preferences::RoutingElectrical::GetFilterBlankingAttribute ( )

Gets the Rlist_Filter_Blanking_Attribute.

Returns: Created in NX4.0.0.

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

NXString NXOpen::Preferences::RoutingElectrical::GetFilterFormatFileName ( )

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

Returns: Created in NX4.0.0.

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

std::vector<NXString> NXOpen::Preferences::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)

Returns: Created in NX4.0.0.

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

bool NXOpen::Preferences::RoutingElectrical::HighlightWire ( )

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

Created in NX4.0.0.

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

bool NXOpen::Preferences::RoutingElectrical::RecordNetlistHistory ( )

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

Created in NX6.0.0.

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

bool NXOpen::Preferences::RoutingElectrical::ReportRouteErrors ( )

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

Created in NX4.0.0.

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

void NXOpen::Preferences::RoutingElectrical::SetAutomaticRouteLevel ( bool isPinLevelRoute )

Sets the level at which to automatically route a path.

Created in NX4.0.0.

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

Parameters

isPinLevelRoute is pin level route

void NXOpen::Preferences::RoutingElectrical::SetAutoRouteStockStyle ( NXOpen::Routing::StockStyle stockStyle )

Sets the option to Auto Route using centerline stock style (i.e.

none) or simple stock style.
Created in NX6.0.0.

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

Parameters

stockStyle Must be either Routing::StockStyleNone ) or Routing::StockStyleSimple ).

void NXOpen::Preferences::RoutingElectrical::SetBundleColor ( int bundleColor )

Sets the default bundle color.

Created in NX4.0.0.

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

Parameters

bundleColor bundle color

void NXOpen::Preferences::RoutingElectrical::SetComponentMatchColumnHeading ( const NXString & columnHeading )

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 NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetComponentMatchColumnHeading ( const char * columnHeading )

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 NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetComponentMatchComponentAttributeTitle ( const NXString & componentAttributeTitle )

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 component attribute title

void NXOpen::Preferences::RoutingElectrical::SetComponentMatchComponentAttributeTitle ( const char * componentAttributeTitle )

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 component attribute title

void NXOpen::Preferences::RoutingElectrical::SetComponentMatchMethod ( NXOpen::Preferences::RoutingElectrical::ComponentMatchType componentMatchMethod )

Sets the component match option for automatic/manual component assignment.

Created in NX4.0.0.

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

Parameters

componentMatchMethod component match method

void NXOpen::Preferences::RoutingElectrical::SetCreateTerminalsOption ( NXOpen::Preferences::RoutingElectrical::CreateTerminalsType createTerminalsOption )

Sets the create terminals option.

Created in NX4.0.0.

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

Parameters

createTerminalsOption create terminals option

void NXOpen::Preferences::RoutingElectrical::SetDefaultHarnessName ( const NXString & defaultHarnessName )

Sets the default harness name
Created in NX4.0.0.

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

Parameters

defaultHarnessName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetDefaultHarnessName ( const char * defaultHarnessName )

Sets the default harness name
Created in NX4.0.0.

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

Parameters

defaultHarnessName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetDefaultJumperLength ( const NXString & defaultJumperLength )

Sets the default length of a jumper wire.

Created in NX4.0.0.

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

Parameters

defaultJumperLength default jumper length

void NXOpen::Preferences::RoutingElectrical::SetDefaultJumperLength ( const char * defaultJumperLength )

Sets the default length of a jumper wire.

Created in NX4.0.0.

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

Parameters

defaultJumperLength default jumper length

void NXOpen::Preferences::RoutingElectrical::SetExportFormatInLegacyFile ( bool exportFormat )

Sets the option to export the format at the top of a legacy routelist file.

Created in NX4.0.0.

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

Parameters

exportFormat export format

void NXOpen::Preferences::RoutingElectrical::SetFilterBlankingAttribute ( const NXString & attributeName )

Sets the Rlist_Filter_Blanking_Attribute.

Created in NX4.0.0.

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

Parameters

attributeName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetFilterBlankingAttribute ( const char * attributeName )

Sets the Rlist_Filter_Blanking_Attribute.

Created in NX4.0.0.

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

Parameters

attributeName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetFilterFormatFileName ( const NXString & filterFormatFileName )

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 NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetFilterFormatFileName ( const char * filterFormatFileName )

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 NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetFormboardFrameSizes ( std::vector< NXString > & frameSizes )

Sets a formboard frame size.

Created in NX4.0.0.

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

Parameters

frameSizes NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingElectrical::SetFormboardSynchronizationLengthTolerance ( double segmentLengthTolerance )

Sets the default segment length tolerance to use for Formboard Synchronization.

Created in NX4.0.0.

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

Parameters

segmentLengthTolerance segment length tolerance

void NXOpen::Preferences::RoutingElectrical::SetHighlightWire ( bool highlightWire )

Sets the option to highlight a wire in the connection list navigator.

Created in NX4.0.0.

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

Parameters

highlightWire highlight wire

void NXOpen::Preferences::RoutingElectrical::SetRecordNetlistHistory ( bool recordNetlistHistory )

Sets the option to record import and export activity in the Connection and Component Lists.

Created in NX6.0.0.

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

Parameters

recordNetlistHistory Should Routing record the netlist history?

void NXOpen::Preferences::RoutingElectrical::SetReportRouteErrors ( bool reportRouteErrors )

Sets the option to report auto/manual route errors to the listing window.

Created in NX4.0.0.

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

Parameters

reportRouteErrors report route errors

void NXOpen::Preferences::RoutingElectrical::SetStandaloneFilterFormatFile ( bool standaloneFilterFormatFile )

Sets the option to export the XML routelist data with the formats and filters information separately.

Created in NX4.0.0.

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

Parameters

standaloneFilterFormatFile standalone filter format file

void NXOpen::Preferences::RoutingElectrical::SetTerminalSegmentSolidDisplay ( bool terminalSegmentSolid )

Sets the terminal segment solid display option
Created in NX4.0.0.

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

Parameters

terminalSegmentSolid terminal segment solid

bool NXOpen::Preferences::RoutingElectrical::StandaloneFilterFormatFile ( )

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

Created in NX4.0.0.

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

tag_t NXOpen::Preferences::RoutingElectrical::Tag ( ) const

Returns the tag of this object.

bool NXOpen::Preferences::RoutingElectrical::TerminalSegmentSolidDisplay ( )

Returns the terminal segment solid display option
Created in NX4.0.0.

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

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

Preferences_RoutingElectrical.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation