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

Contains the preferences related to placing/finding/adding parts and generating the Routing bill of materials. More...

List of all members.

Public Types

enum  DetailLevel { DetailLevelSummary, DetailLevelItemized }
 The detail levels available for the Routing bill of material. More...
enum  FabricationNumbering { FabricationNumberingSequence, FabricationNumberingOriginal }
 The fabrication numbering methods available for the Routing bill of material. More...
enum  PreferredPortMethod { PreferredPortMethodAttribute, PreferredPortMethodName }
 Available methods for determining which port is the preferredport during calculation of placement solutions. More...
enum  StockLengthDisplay { StockLengthDisplaySum, StockLengthDisplayItem }
 The stock length display options available for the Routing bill of material. More...
enum  UsePreferredPort { UsePreferredPortFalse, UsePreferredPortTrue }
 Whether or not use the preferred port when determining placement solutions. More...

Public Member Functions

NXOpen::Preferences::RoutingPart::DetailLevel BomDetailLevelFlag ()
 Returns the detail level for the Routing bill of material.
NXString BomFormatPart ()
 Returns the name of the template Routing bill of material part file.
NXString DefaultElbowNode ()
 Returns the node in the part library to use for searching for the default elbow to place during create path.
NXOpen::Preferences::RoutingPart::FabricationNumbering FabricationNumberingFlag ()
 Returns the fabrication numbering for the Routing bill of material.
void GetPreferredPortAttribute (NXString *attributeName, NXString *attributeValue)
 Gets the attribute and it's value for determining the preferred port for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute
Created in NX4.0.0.
NXString GetPreferredPortName ()
 Gets the desired port name for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodName.
NXString InvalidSequenceCharacters ()
 Returns the list of characters that cannot be used when generating sequences of terminals in qualify part.
int Layer ()
 Returns the layer to apply to new components.
int MaximumSolutions ()
 Returns the maximum number of placement solutions to generate when determining placement solutions for a component.
NXOpen::Preferences::RoutingPartLibraryPartLibrary ()
 The Routing part library.
NXOpen::Preferences::RoutingPart::PreferredPortMethod PreferredPortMethodFlag ()
 Returns the current method for determining the preferred placement port.
void SetBomDetailLevelFlag (NXOpen::Preferences::RoutingPart::DetailLevel detail)
 Sets the detail level for the Routing bill of material.
void SetBomFormatPart (const NXString &bomPart)
 Sets the name of the template Routing bill of material part file.
void SetDefaultElbowNode (const NXString &elbowNode)
 Sets the node in the part library to use for searching for the default elbow to place during create path.
void SetFabricationNumberingFlag (NXOpen::Preferences::RoutingPart::FabricationNumbering numbering)
 Sets the fabrication numbering for the Routing bill of material.
void SetInvalidSequenceCharacters (const NXString &invalidChars)
 Sets the list of characters that cannot be used when generating sequences of terminals in qualify part.
void SetLayer (int layer)
 Sets the layer to apply to new components.
void SetMaximumSolutions (int maxSols)
 Sets the maximum number of placement solutions to generate when determining placement solutions for a component.
void SetPreferredPortAttribute (const NXString &attributeName, const NXString &attributeValue)
 Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute and sets the desired port attribute and it's value.
void SetPreferredPortName (const NXString &desiredPort)
 Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name.
void SetStockLengthDisplayFlag (NXOpen::Preferences::RoutingPart::StockLengthDisplay display)
 Sets the stock length display for the Routing bill of material.
void SetUsePreferredPortFlag (NXOpen::Preferences::RoutingPart::UsePreferredPort useFlag)
 Sets whether or not to use the preffered placement port during calcluation of placement solutions during place part.
NXOpen::Preferences::RoutingPart::StockLengthDisplay StockLengthDisplayFlag ()
 Returns the stock length display for the Routing bill of material.
tag_t Tag () const
 Returns the tag of this object.
NXOpen::Preferences::RoutingPart::UsePreferredPort UsePreferredPortFlag ()
 Returns whether or not to use the preffered placement port during calcluation of placement solutions during place part.

Detailed Description

Contains the preferences related to placing/finding/adding parts and generating the Routing bill of materials.


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

Created in NX4.0.0.


Member Enumeration Documentation

The detail levels available for the Routing bill of material.

Enumerator:
DetailLevelSummary 

summary

DetailLevelItemized 

itemized

The fabrication numbering methods available for the Routing bill of material.

Enumerator:
FabricationNumberingSequence 

Sequential numbering of fabrications in the parts list.

FabricationNumberingOriginal 

Use the fabrication number in the parts list.

Available methods for determining which port is the preferredport during calculation of placement solutions.

Enumerator:
PreferredPortMethodAttribute 

Examine an attribute applied to the port, and match it's value to a desired value.

PreferredPortMethodName 

Compare the ports name with a desired value.

The stock length display options available for the Routing bill of material.

Enumerator:
StockLengthDisplaySum 

Display single sum for each type of stock.

StockLengthDisplayItem 

Display length of each stock individually.

Whether or not use the preferred port when determining placement solutions.

Enumerator:
UsePreferredPortFalse 

false

UsePreferredPortTrue 

true


Member Function Documentation

Returns the detail level for the Routing bill of material.


Created in NX4.0.0.

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

Returns the name of the template Routing bill of material part file.


Created in NX4.0.0.

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

Returns the node in the part library to use for searching for the default elbow to place during create path.

The part library node must have a type of NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable . A NULL node indicates no default elbow part table.
Created in NX4.0.0.

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

Returns the fabrication numbering for the Routing bill of material.


Created in NX4.0.0.

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

void NXOpen::Preferences::RoutingPart::GetPreferredPortAttribute ( NXString attributeName,
NXString attributeValue 
)

Gets the attribute and it's value for determining the preferred port for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute
Created in NX4.0.0.



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

Parameters:
attributeNameNULL if method is not NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute
attributeValueNULL if method is not NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute

Gets the desired port name for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodName.

Returns:
NULL if method is not NXOpen::Preferences::RoutingPart::PreferredPortMethodName
Created in NX4.0.0.

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

Returns the list of characters that cannot be used when generating sequences of terminals in qualify part.


Created in NX4.0.0.

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

Returns the layer to apply to new components.


Created in NX4.0.0.

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

Returns the maximum number of placement solutions to generate when determining placement solutions for a component.


Created in NX4.0.0.

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

The Routing part library.


Created in NX3.0.0.

Returns the current method for determining the preferred placement port.


Created in NX4.0.0.

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

Sets the detail level for the Routing bill of material.


Created in NX4.0.0.

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

Parameters:
detaildetail

Sets the name of the template Routing bill of material part file.


Created in NX4.0.0.

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

Parameters:
bomPartbom part

Sets the node in the part library to use for searching for the default elbow to place during create path.

The part library node must have a type of NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable . A NULL node indicates no default elbow part table.
Created in NX4.0.0.

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

Parameters:
elbowNodeelbow node

Sets the fabrication numbering for the Routing bill of material.


Created in NX4.0.0.

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

Parameters:
numberingnumbering

Sets the list of characters that cannot be used when generating sequences of terminals in qualify part.


Created in NX4.0.0.

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

Parameters:
invalidCharsinvalid chars

Sets the layer to apply to new components.


Created in NX4.0.0.

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

Parameters:
layerlayer

Sets the maximum number of placement solutions to generate when determining placement solutions for a component.


Created in NX4.0.0.

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

Parameters:
maxSolsmax sols
void NXOpen::Preferences::RoutingPart::SetPreferredPortAttribute ( const NXString attributeName,
const NXString attributeValue 
)

Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute and sets the desired port attribute and it's value.


Created in NX4.0.0.

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

Parameters:
attributeNameAttribute name on port to match. Must not be NULL and the length of the string must be less than 50.
NOTE: The full Unicode character set is not supported for this parameter.
attributeValueValue of the attribute to match.
NOTE: The full Unicode character set is not supported for this parameter.

Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name.


Created in NX4.0.0.

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

Parameters:
desiredPortPort name to match. Must not be NULL and the length of the string must be less than 50.
NOTE: The full Unicode character set is not supported for this parameter.

Sets the stock length display for the Routing bill of material.


Created in NX4.0.0.

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

Parameters:
displaydisplay

Sets whether or not to use the preffered placement port during calcluation of placement solutions during place part.


Created in NX4.0.0.

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

Parameters:
useFlaguse flag

Returns the stock length display for the Routing bill of material.


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 whether or not to use the preffered placement port during calcluation of placement solutions during place part.


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.