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

The RoutingMechanical object stores a set of route mechanical preferences. More...

List of all members.

Public Types

enum  LineColorType {
  LineColorTypeUnknown = -1, LineColorTypeName, LineColorTypeIndex, LineColorTypeRgb,
  LineColorTypeHex, LineColorTypeMax
}
 Describes the Line color string definition types. More...

Public Member Functions

bool GetIsInitialized ()
 Returns the information of whether the mechanical preferences section exists in the application view file.
std::vector< NXStringGetLineColors ()
 Returns the name, index or rgb strings (hex or , seperated) of line color.
std::vector
< NXOpen::Preferences::RoutingMechanical::LineColorType
GetLineColorTypes ()
 Returns types of string in line_color field.
std::vector< int > GetLineFontIndices ()
 Returns the line font indices: line font to apply to segments in the run (currently 1-7 supported), 0 indicates unknown line font.
std::vector< NXStringGetLineFonts ()
 Returns the names of line font to apply to segments, only used if line_font_index is 0.
std::vector< int > GetLineWidths ()
 Returns the thicknesses of segments (currently 0-2 supported)
std::vector< NXStringGetRunTypeNames ()
 Returns the names of run type displays.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

The RoutingMechanical object stores a set of route mechanical preferences.


To obtain an instance of this class, refer to Preferences::RoutingApplicationView

Created in NX4.0.0.


Member Enumeration Documentation

Describes the Line color string definition types.

Enumerator:
LineColorTypeName 

name

LineColorTypeIndex 

index

LineColorTypeRgb 

rgb

LineColorTypeHex 

hex

LineColorTypeMax 

max


Member Function Documentation

Returns the information of whether the mechanical preferences section exists in the application view file.

Returns:

Created in NX4.0.0.

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

Returns the name, index or rgb strings (hex or , seperated) of line color.

Returns:

Created in NX4.0.0.

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

Returns types of string in line_color field.

Valid values are specified by the Preferences::RoutingMechanical::LineColorType .

Returns:

Created in NX4.0.0.

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

Returns the line font indices: line font to apply to segments in the run (currently 1-7 supported), 0 indicates unknown line font.

Returns:

Created in NX4.0.0.

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

Returns the names of line font to apply to segments, only used if line_font_index is 0.

Returns:

Created in NX4.0.0.

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

Returns the thicknesses of segments (currently 0-2 supported)

Returns:

Created in NX4.0.0.

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

Returns the names of run type displays.

Returns:

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.


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