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

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. More...

std::vector< NXString >	GetLineColors ()
	Returns the name, index or rgb strings (hex or , separated) of line color. More...

std::vector < NXOpen::Preferences::RoutingMechanical::LineColorType >	GetLineColorTypes ()
	Returns types of string in line_color field. More...

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. More...

std::vector< NXString >	GetLineFonts ()
	Returns the names of line font to apply to segments, only used if line_font_index is 0. More...

std::vector< int >	GetLineWidths ()
	Returns the thicknesses of segments (currently 0-2 supported) More...

std::vector< NXString >	GetRunTypeNames ()
	Returns the names of run type displays. More...

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

Detailed Description

The RoutingMechanical object stores a set of route mechanical preferences.

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

Created in NX4.0.0.

Member Enumeration Documentation

Describes the Line color string definition types.

bool NXOpen::Preferences::RoutingMechanical::GetIsInitialized ( )

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

Returns: Created in NX4.0.0.

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

std::vector<NXString> NXOpen::Preferences::RoutingMechanical::GetLineColors ( )

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

Returns: Created in NX4.0.0.

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

std::vector<NXOpen::Preferences::RoutingMechanical::LineColorType> NXOpen::Preferences::RoutingMechanical::GetLineColorTypes ( )

Returns types of string in line_color field.

Returns: Created in NX4.0.0.

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

std::vector<int> NXOpen::Preferences::RoutingMechanical::GetLineFontIndices ( )

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")

std::vector<NXString> NXOpen::Preferences::RoutingMechanical::GetLineFonts ( )

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")

std::vector<int> NXOpen::Preferences::RoutingMechanical::GetLineWidths ( )

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

Returns: Created in NX4.0.0.

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

std::vector<NXString> NXOpen::Preferences::RoutingMechanical::GetRunTypeNames ( )

Returns the names of run type displays.

Returns: Created in NX4.0.0.

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

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

Returns the tag of this object.

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