RoutingPart Class

class NXOpen.Preferences.RoutingPart

Bases: object

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 NXOpen.Preferences.RoutingApplicationView

New in version NX4.0.0.

Properties

Property	Description
BomDetailLevelFlag	Returns or sets the detail level for the Routing bill of material.
BomFormatPart	Returns or sets the name of the template Routing bill of material part file.
DefaultElbowNode	Returns or sets the node in the part library to use for searching for the default elbow to place during create path.
FabricationNumberingFlag	Returns or sets the fabrication numbering for the Routing bill of material.
InvalidSequenceCharacters	Returns or sets the list of characters that cannot be used when generating sequences of terminals in qualify part.
Layer	Returns or sets the layer to apply to new components.
MaximumSolutions	Returns or sets the maximum number of placement solutions to generate when determining placement solutions for a component.
PreferredPortMethodFlag	Returns the current method for determining the preferred placement port.
StockLengthDisplayFlag	Returns or sets the stock length display for the Routing bill of material.
UsePreferredPortFlag	Returns or sets whether or not to use the preffered placement port during calcluation of placement solutions during place part.
PartLibrary	The Routing part library.

Methods

Method	Description
GetPreferredPortAttribute	Gets the attribute and it’s value for determining the preferred port for method type NXOpen.Preferences.RoutingPartPreferredPortMethod.Attribute
GetPreferredPortName	Gets the desired port name for method type NXOpen.Preferences.RoutingPartPreferredPortMethod.Name
SetPreferredPortAttribute	Sets the method for determining the preferred port to NXOpen.Preferences.RoutingPartPreferredPortMethod.Attribute and sets the desired port attribute and it’s value.
SetPreferredPortName	Sets the method for determining the preferred port to NXOpen.Preferences.RoutingPartPreferredPortMethod.Name and sets the desired port name.

Enumerations

RoutingPartDetailLevel Enumeration	The detail levels available for the Routing bill of material.
RoutingPartFabricationNumbering Enumeration	The fabrication numbering methods available for the Routing bill of material.
RoutingPartPreferredPortMethod Enumeration	Available methods for determining which port is the preferredport during calculation of placement solutions.
RoutingPartStockLengthDisplay Enumeration	The stock length display options available for the Routing bill of material.
RoutingPartUsePreferredPort Enumeration	Whether or not use the preferred port when determining placement solutions.

Property Detail

BomDetailLevelFlag

RoutingPart.BomDetailLevelFlag

Returns or sets the detail level for the Routing bill of material.

-------------------------------------

Getter Method

Signature BomDetailLevelFlag

Returns: Return type:NXOpen.Preferences.RoutingPartDetailLevel

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature BomDetailLevelFlag

Parameters:detail (NXOpen.Preferences.RoutingPartDetailLevel) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

BomFormatPart

RoutingPart.BomFormatPart

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

-------------------------------------

Getter Method

Signature BomFormatPart

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature BomFormatPart

Parameters:bomPart (str) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

DefaultElbowNode

RoutingPart.DefaultElbowNode

Returns or 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.RoutingPartLibraryNodeType.Table. A None node indicates no default elbow part table.

-------------------------------------

Getter Method

Signature DefaultElbowNode

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature DefaultElbowNode

Parameters:elbowNode (str) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

FabricationNumberingFlag

RoutingPart.FabricationNumberingFlag

Returns or sets the fabrication numbering for the Routing bill of material.

-------------------------------------

Getter Method

Signature FabricationNumberingFlag

Returns: Return type:NXOpen.Preferences.RoutingPartFabricationNumbering

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature FabricationNumberingFlag

Parameters:numbering (NXOpen.Preferences.RoutingPartFabricationNumbering) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

InvalidSequenceCharacters

RoutingPart.InvalidSequenceCharacters

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

-------------------------------------

Getter Method

Signature InvalidSequenceCharacters

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature InvalidSequenceCharacters

Parameters:invalidChars (str) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

Layer

RoutingPart.Layer

Returns or sets the layer to apply to new components.

-------------------------------------

Getter Method

Signature Layer

Returns:The layer to place the new component on

-1 means use the original layers defined in the component. 0 means use the work layer. 1-256 means use the specified layer. :rtype: int

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature Layer

Parameters:layer (int) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

MaximumSolutions

RoutingPart.MaximumSolutions

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

-------------------------------------

Getter Method

Signature MaximumSolutions

Returns: Return type:int

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature MaximumSolutions

Parameters:maxSols (int) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

PreferredPortMethodFlag

RoutingPart.PreferredPortMethodFlag

Returns the current method for determining the preferred placement port.

-------------------------------------

Getter Method

Signature PreferredPortMethodFlag

Returns: Return type:NXOpen.Preferences.RoutingPartPreferredPortMethod

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

StockLengthDisplayFlag

RoutingPart.StockLengthDisplayFlag

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

-------------------------------------

Getter Method

Signature StockLengthDisplayFlag

Returns: Return type:NXOpen.Preferences.RoutingPartStockLengthDisplay

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature StockLengthDisplayFlag

Parameters:display (NXOpen.Preferences.RoutingPartStockLengthDisplay) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

UsePreferredPortFlag

RoutingPart.UsePreferredPortFlag

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

-------------------------------------

Getter Method

Signature UsePreferredPortFlag

Returns: Return type:NXOpen.Preferences.RoutingPartUsePreferredPort

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature UsePreferredPortFlag

Parameters:useFlag (NXOpen.Preferences.RoutingPartUsePreferredPort) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

PartLibrary

RoutingPart.PartLibrary

The Routing part library.

Signature PartLibrary

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingPartLibrary

Method Detail

GetPreferredPortAttribute

RoutingPart.GetPreferredPortAttribute

Gets the attribute and it’s value for determining the preferred port for method type NXOpen.Preferences.RoutingPartPreferredPortMethod.Attribute

Signature GetPreferredPortAttribute()

Returns:a tuple Return type:A tuple consisting of (attributeName, attributeValue)

attributeName is a str. None if method is not NXOpen.Preferences.RoutingPartPreferredPortMethod.Attribute attributeValue is a str. None if method is not NXOpen.Preferences.RoutingPartPreferredPortMethod.Attribute .. versionadded:: NX4.0.0

License requirements: routing_base (“Routing Basic”)

GetPreferredPortName

RoutingPart.GetPreferredPortName

Gets the desired port name for method type NXOpen.Preferences.RoutingPartPreferredPortMethod.Name

Signature GetPreferredPortName()

Returns:None if method is not

NXOpen.Preferences.RoutingPartPreferredPortMethod.Name :rtype: str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

SetPreferredPortAttribute

RoutingPart.SetPreferredPortAttribute

Sets the method for determining the preferred port to NXOpen.Preferences.RoutingPartPreferredPortMethod.Attribute and sets the desired port attribute and it’s value.

Signature SetPreferredPortAttribute(attributeName, attributeValue)

Parameters:

• attributeName (str) – Attribute name on port to match. Must not be None and the length of the string must be less than 50.
• attributeValue (str) – Value of the attribute to match.

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

SetPreferredPortName

RoutingPart.SetPreferredPortName

Sets the method for determining the preferred port to NXOpen.Preferences.RoutingPartPreferredPortMethod.Name and sets the desired port name.

Signature SetPreferredPortName(desiredPort)

Parameters:desiredPort (str) – Port name to match. Must not be None and the length of the string must be less than 50.

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)