NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::RoutingElectrical Class Reference

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

List of all members.

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< NXStringGetFormboardFrameSizes ()
 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 SetComponentMatchComponentAttributeTitle (const NXString &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 SetDefaultJumperLength (const NXString &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 SetFilterFormatFileName (const NXString &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

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.

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

Returns the level at which to automatically route a path.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the default bundle color.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the create terminals option.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the default length of a jumper wire.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Gets the Rlist_Filter_Blanking_Attribute.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Sets the level at which to automatically route a path.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
isPinLevelRouteis pin level route

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockStyleMust be either Routing::StockStyleNone ) or Routing::StockStyleSimple ).

Sets the default bundle color.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
bundleColorbundle color

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
componentAttributeTitlecomponent attribute title

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
componentMatchMethodcomponent match method

Sets the create terminals option.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
createTerminalsOptioncreate terminals option

Sets the default harness name
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

Sets the default length of a jumper wire.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
defaultJumperLengthdefault jumper length

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
exportFormatexport format

Sets the Rlist_Filter_Blanking_Attribute.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

Sets a formboard frame size.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
segmentLengthTolerancesegment length tolerance

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
highlightWirehighlight wire

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


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
recordNetlistHistoryShould Routing record the netlist history?

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
reportRouteErrorsreport route errors

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
standaloneFilterFormatFilestandalone filter format file

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



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
terminalSegmentSolidterminal segment solid

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


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the tag of this object.

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



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.