NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Preferences.RoutingPart Class Reference

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

Inheritance diagram for NXOpen.Preferences.RoutingPart:
NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  DetailLevel { Summary, Itemized }
 The detail levels available for the Routing bill of material. More...
 
enum  FabricationNumbering { Sequence, Original }
 The fabrication numbering methods available for the Routing bill of material. More...
 
enum  PreferredPortMethod { Attribute, Name }
 Available methods for determining which port is the preferredport during calculation of placement solutions. More...
 
enum  StockLengthDisplay { Sum, Item }
 The stock length display options available for the Routing bill of material. More...
 
enum  UsePreferredPort { False, True }
 Whether or not use the preferred port when determining placement solutions. More...
 

Public Member Functions

unsafe void GetPreferredPortAttribute (out string attributeName, out string attributeValue)
 Gets the attribute and it's value for determining the preferred port for method type NXOpen.Preferences.RoutingPart.PreferredPortMethod.Attribute More...
 
unsafe string GetPreferredPortName ()
 Gets the desired port name for method type NXOpen.Preferences.RoutingPart.PreferredPortMethod.Name More...
 
unsafe void SetPreferredPortAttribute (string attributeName, string attributeValue)
 Sets the method for determining the preferred port to NXOpen.Preferences.RoutingPart.PreferredPortMethod.Attribute and sets the desired port attribute and it's value. More...
 
unsafe void SetPreferredPortName (string desiredPort)
 Sets the method for determining the preferred port to NXOpen.Preferences.RoutingPart.PreferredPortMethod.Name and sets the desired port name. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Preferences.RoutingPart.DetailLevel 
BomDetailLevelFlag [get, set]
 Returns or sets the detail level for the Routing bill of material. More...
 
unsafe string BomFormatPart [get, set]
 Returns or sets the name of the template Routing bill of material part file. More...
 
unsafe string DefaultElbowNode [get, set]
 Returns or sets the node in the part library to use for searching for the default elbow to place during create path. More...
 
unsafe
NXOpen.Preferences.RoutingPart.FabricationNumbering 
FabricationNumberingFlag [get, set]
 Returns or sets the fabrication numbering for the Routing bill of material. More...
 
unsafe string InvalidSequenceCharacters [get, set]
 Returns or sets the list of characters that cannot be used when generating sequences of terminals in qualify part. More...
 
unsafe int Layer [get, set]
 Returns or sets the layer to apply to new components. More...
 
unsafe int MaximumSolutions [get, set]
 Returns or sets the maximum number of placement solutions to generate when determining placement solutions for a component. More...
 
NXOpen.Preferences.RoutingPartLibrary PartLibrary [get]
 The Routing part library. More...
 
unsafe
NXOpen.Preferences.RoutingPart.PreferredPortMethod 
PreferredPortMethodFlag [get]
 Returns the current method for determining the preferred placement port. More...
 
unsafe
NXOpen.Preferences.RoutingPart.StockLengthDisplay 
StockLengthDisplayFlag [get, set]
 Returns or sets the stock length display for the Routing bill of material. More...
 
Tag Tag [get]
 Returns the tag of this object. More...
 
unsafe
NXOpen.Preferences.RoutingPart.UsePreferredPort 
UsePreferredPortFlag [get, set]
 Returns or sets whether or not to use the preffered placement port during calcluation of placement solutions during place part. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

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

Created in NX4.0.0

Member Enumeration Documentation

The detail levels available for the Routing bill of material.

Enumerator
Summary 
Itemized 

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

Enumerator
Sequence 

Sequential numbering of fabrications in the parts list.

Original 

Use the fabrication number in the parts list.

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

Enumerator
Attribute 

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

Name 

Compare the ports name with a desired value.

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

Enumerator
Sum 

Display single sum for each type of stock.

Item 

Display length of each stock individually.

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

Enumerator
False 
True 

Member Function Documentation

unsafe void NXOpen.Preferences.RoutingPart.GetPreferredPortAttribute ( out string  attributeName,
out string  attributeValue 
)
inline

Gets the attribute and it's value for determining the preferred port for method type NXOpen.Preferences.RoutingPart.PreferredPortMethod.Attribute

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters
attributeNamea null reference (Nothing in Visual Basic) if method is not NXOpen.Preferences.RoutingPart.PreferredPortMethod.Attribute
attributeValuea null reference (Nothing in Visual Basic) if method is not NXOpen.Preferences.RoutingPart.PreferredPortMethod.Attribute
unsafe string NXOpen.Preferences.RoutingPart.GetPreferredPortName ( )
inline

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

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns
a null reference (Nothing in Visual Basic) if method is not NXOpen.Preferences.RoutingPart.PreferredPortMethod.Name
unsafe void NXOpen.Preferences.RoutingPart.SetPreferredPortAttribute ( string  attributeName,
string  attributeValue 
)
inline

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

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters
attributeNameAttribute name on port to match. Must not be a null reference (Nothing in Visual Basic) and the length of the string must be less than 50.
attributeValueValue of the attribute to match.
unsafe void NXOpen.Preferences.RoutingPart.SetPreferredPortName ( string  desiredPort)
inline

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

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters
desiredPortPort name to match. Must not be a null reference (Nothing in Visual Basic) and the length of the string must be less than 50.

Property Documentation

unsafe NXOpen.Preferences.RoutingPart.DetailLevel NXOpen.Preferences.RoutingPart.BomDetailLevelFlag
getset

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

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingPart.BomFormatPart
getset

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

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingPart.DefaultElbowNode
getset

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.RoutingPartLibrary.NodeType.Table . A a null reference (Nothing in Visual Basic) node indicates no default elbow part table.

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Preferences.RoutingPart.FabricationNumbering NXOpen.Preferences.RoutingPart.FabricationNumberingFlag
getset

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

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingPart.InvalidSequenceCharacters
getset

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

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe int NXOpen.Preferences.RoutingPart.Layer
getset

Returns or sets the layer to apply to new components.

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe int NXOpen.Preferences.RoutingPart.MaximumSolutions
getset

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

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

NXOpen.Preferences.RoutingPartLibrary NXOpen.Preferences.RoutingPart.PartLibrary
get

The Routing part library.

Created in NX3.0.0

unsafe NXOpen.Preferences.RoutingPart.PreferredPortMethod NXOpen.Preferences.RoutingPart.PreferredPortMethodFlag
get

Returns the current method for determining the preferred placement port.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Preferences.RoutingPart.StockLengthDisplay NXOpen.Preferences.RoutingPart.StockLengthDisplayFlag
getset

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

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

Tag NXOpen.Preferences.RoutingPart.Tag
get

Returns the tag of this object.

unsafe NXOpen.Preferences.RoutingPart.UsePreferredPort NXOpen.Preferences.RoutingPart.UsePreferredPortFlag
getset

Returns or 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 to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")


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