|
NX Open C++ Reference Guide
|
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. More... | |
| NXOpen::Routing::StockStyle | AutoRouteStockStyle () |
| Returns the option to Auto Route using centerline stock style (i.e. More... | |
| int | BundleColor () |
| Returns the default bundle color. More... | |
| NXOpen::Preferences::RoutingElectrical::ComponentMatchType | ComponentMatchMethod () |
| Returns the component match option for automatic/manual component assignment. More... | |
| NXOpen::Preferences::RoutingElectrical::CreateTerminalsType | CreateTerminalsOption () |
| Returns the create terminals option. More... | |
| NXString | DefaultJumperLength () |
| Returns the default length of a jumper wire. More... | |
| bool | ExportFormatInLegacyFile () |
| Returns the option to export the format at the top of a legacy routelist file. More... | |
| double | FormboardSynchronizationLengthTolerance () |
| Returns the default segment length tolerance to use for Formboard Synchronization. More... | |
| NXString | GetComponentMatchColumnHeading () |
| Gets the column name of the component list used for component matching if the method is attribute matching. More... | |
| NXString | GetComponentMatchComponentAttributeTitle () |
| Gets the component attribute name used for component matching if the method is attribute matching. More... | |
| NXString | GetDefaultHarnessName () |
| Gets the default harness name. More... | |
| NXString | GetFilterBlankingAttribute () |
| Gets the Rlist_Filter_Blanking_Attribute. More... | |
| NXString | GetFilterFormatFileName () |
| Gets the file name for the stand alone XML filters and formats file. More... | |
| std::vector< NXString > | GetFormboardFrameSizes () |
| Gets the formboard frame sizes currently specified within the Routing Electrical application. More... | |
| bool | HighlightWire () |
| Returns the option to highlight a wire in the connection list navigator. More... | |
| bool | RecordNetlistHistory () |
| Returns the option to record import and export activity in the Connection and Component Lists. More... | |
| bool | ReportRouteErrors () |
| Returns the option to report auto/manual route errors to the listing window. More... | |
| void | SetAutomaticRouteLevel (bool isPinLevelRoute) |
| Sets the level at which to automatically route a path. More... | |
| void | SetAutoRouteStockStyle (NXOpen::Routing::StockStyle stockStyle) |
| Sets the option to Auto Route using centerline stock style (i.e. More... | |
| void | SetBundleColor (int bundleColor) |
| Sets the default bundle color. More... | |
| void | SetComponentMatchColumnHeading (const NXString &columnHeading) |
| Sets the column name of the component list used for component matching if the method is attribute matching. More... | |
| void | SetComponentMatchColumnHeading (const char *columnHeading) |
| Sets the column name of the component list used for component matching if the method is attribute matching. More... | |
| void | SetComponentMatchComponentAttributeTitle (const NXString &componentAttributeTitle) |
| Sets the component attribute name used for component matching if the method is attribute matching. More... | |
| void | SetComponentMatchComponentAttributeTitle (const char *componentAttributeTitle) |
| Sets the component attribute name used for component matching if the method is attribute matching. More... | |
| void | SetComponentMatchMethod (NXOpen::Preferences::RoutingElectrical::ComponentMatchType componentMatchMethod) |
| Sets the component match option for automatic/manual component assignment. More... | |
| void | SetCreateTerminalsOption (NXOpen::Preferences::RoutingElectrical::CreateTerminalsType createTerminalsOption) |
| Sets the create terminals option. More... | |
| void | SetDefaultHarnessName (const NXString &defaultHarnessName) |
| Sets the default harness name Created in NX4.0.0. More... | |
| void | SetDefaultHarnessName (const char *defaultHarnessName) |
| Sets the default harness name Created in NX4.0.0. More... | |
| void | SetDefaultJumperLength (const NXString &defaultJumperLength) |
| Sets the default length of a jumper wire. More... | |
| void | SetDefaultJumperLength (const char *defaultJumperLength) |
| Sets the default length of a jumper wire. More... | |
| void | SetExportFormatInLegacyFile (bool exportFormat) |
| Sets the option to export the format at the top of a legacy routelist file. More... | |
| void | SetFilterBlankingAttribute (const NXString &attributeName) |
| Sets the Rlist_Filter_Blanking_Attribute. More... | |
| void | SetFilterBlankingAttribute (const char *attributeName) |
| Sets the Rlist_Filter_Blanking_Attribute. More... | |
| void | SetFilterFormatFileName (const NXString &filterFormatFileName) |
| Sets the file name for the stand alone XML filters and formats file. More... | |
| void | SetFilterFormatFileName (const char *filterFormatFileName) |
| Sets the file name for the stand alone XML filters and formats file. More... | |
| void | SetFormboardFrameSizes (std::vector< NXString > &frameSizes) |
| Sets a formboard frame size. More... | |
| void | SetFormboardSynchronizationLengthTolerance (double segmentLengthTolerance) |
| Sets the default segment length tolerance to use for Formboard Synchronization. More... | |
| void | SetHighlightWire (bool highlightWire) |
| Sets the option to highlight a wire in the connection list navigator. More... | |
| void | SetRecordNetlistHistory (bool recordNetlistHistory) |
| Sets the option to record import and export activity in the Connection and Component Lists. More... | |
| void | SetReportRouteErrors (bool reportRouteErrors) |
| Sets the option to report auto/manual route errors to the listing window. More... | |
| void | SetStandaloneFilterFormatFile (bool standaloneFilterFormatFile) |
| Sets the option to export the XML routelist data with the formats and filters information separately. More... | |
| void | SetTerminalSegmentSolidDisplay (bool terminalSegmentSolid) |
| Sets the terminal segment solid display option Created in NX4.0.0. More... | |
| bool | StandaloneFilterFormatFile () |
| Returns the option to export the XML routelist data with the formats and filters information separately. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
| bool | TerminalSegmentSolidDisplay () |
| Returns the terminal segment solid display option Created in NX4.0.0. More... | |
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.
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.
| 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.
| NXString NXOpen::Preferences::RoutingElectrical::GetComponentMatchComponentAttributeTitle | ( | ) |
Gets the component attribute name used for component matching if the method is attribute matching.
| 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.
| NXString NXOpen::Preferences::RoutingElectrical::GetFilterBlankingAttribute | ( | ) |
Gets the Rlist_Filter_Blanking_Attribute.
| NXString NXOpen::Preferences::RoutingElectrical::GetFilterFormatFileName | ( | ) |
Gets the file name for the stand alone XML filters and formats file.
| 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)
| 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")
| 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")
| stockStyle | Must be either NXOpen::Routing::StockStyleNone ) or NXOpen::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")
| 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")
| columnHeading | column heading |
| 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")
| columnHeading | column heading |
| 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")
| 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")
| 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")
| 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")
| 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")
| defaultHarnessName | default harness name |
| 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")
| defaultHarnessName | default harness name |
| 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")
| 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")
| 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")
| 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")
| attributeName | attribute name |
| 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")
| attributeName | attribute name |
| 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")
| filterFormatFileName | filter format file name |
| 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")
| filterFormatFileName | filter format file name |
| 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")
| frameSizes | frame sizes |
| 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")
| 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")
| 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")
| 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")
| 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")
| 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")
| 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")