Represents a Routing Part library. More...

Inheritance diagram for NXOpen.Preferences.RoutingPartLibrary:

Classes
struct	_Column
	Part table column type.

struct	Column
	Part table column type. More...

Public Types
enum	ColumnStatus { NotHidden, Hidden }
	Hidden status of a column. More...

enum	ColumnType { Integer, Real, String = 4 }
	Type of column values. More...

enum	NodeType { Normal, Table, Part }
	Type of nodes in the part library. More...

enum	RootType { Top, Stock, Wire, Part }
	Type of root nodes. More...

Public Member Functions
unsafe NXOpen.Routing.CharacteristicList	CreateCriteria ()
	Creates a new empty NXOpen.Routing.CharacteristicList object that can be used as input to Preferences.RoutingPartLibrary.MatchCriteria and Preferences.RoutingPartLibrary.MatchCriteriaWithFilter . More...

unsafe bool	FilterOnCurrentSpecifications (NXOpen.Routing.CharacteristicList match, string[] partClasses)
	Does a characteristic list match the current discipline and specifications? More...

unsafe string[]	GetChildrenNodes (string parent)
	Returns the children nodes of the input node. More...

unsafe string	GetFilteredRoot (NXOpen.Preferences.RoutingPartLibrary.RootType rootType)
	Returns the root node of the part library using the current active discipline. More...

unsafe NXOpen.Preferences.RoutingPartLibrary.NodeType	GetNodeType (string node)
	Returns the node type. More...

unsafe NXOpen.Routing.CharacteristicList	GetPartDefinition (string node)
	Returns the part information for a given NXOpen.Preferences.RoutingPartLibrary.NodeType.Part node. More...

unsafe string	GetRoot ()
	Returns the root node of the part library. More...

unsafe NXOpen.Preferences.RoutingPartLibrary.Column[]	GetTableDefinition (string node)
	Returns the table information for a given NXOpen.Preferences.RoutingPartLibrary.NodeType.Table node. More...

unsafe NXOpen.Routing.CharacteristicList[]	MatchCriteria (string startNode, NXOpen.Routing.CharacteristicList criteria)
	Search for entries in the part library table nodes that match the given set of criteria. More...

unsafe NXOpen.Routing.CharacteristicList[]	MatchCriteriaWithFilter (string startNode, NXOpen.Routing.CharacteristicList criteria)
	Similar to Preferences.RoutingPartLibrary.MatchCriteria , however it also filters out any parts that don't match the critiera specified by the current specification. 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
Tag	Tag `[get]`
	Returns the tag of this object. 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

Represents a Routing Part library.

To obtain an instance of this class, refer to NXOpen.Preferences.RoutingPart

Created in NX4.0.0

Member Enumeration Documentation

enum NXOpen.Preferences.RoutingPartLibrary.ColumnStatus

Hidden status of a column.

Enumerator
NotHidden	Column is displayed in Specify Item.
Hidden	Column is not displayed in Specify Item.

enum NXOpen.Preferences.RoutingPartLibrary.ColumnType

Type of column values.

Enumerator
Integer	Integer values.
Real	Floating-point values.
String	String values.

enum NXOpen.Preferences.RoutingPartLibrary.NodeType

Type of nodes in the part library.

Enumerator

Normal

Normal node, may contain part table children.

Doesn't have any part table information.

Table

Part table node.

Contains columns/rows that specify parts.

Part

Part node, contains information necessary for loading/using a routing part.

enum NXOpen.Preferences.RoutingPartLibrary.RootType

Type of root nodes.

Enumerator
Top	Top of entire part table.
Stock	Top node for selecting stocks.
Wire	Top node for selecting wires.
Part	Top node for selecting parts.

Member Function Documentation

unsafe NXOpen.Routing.CharacteristicList NXOpen.Preferences.RoutingPartLibrary.CreateCriteria ( )

inline

Creates a new empty NXOpen.Routing.CharacteristicList object that can be used as input to Preferences.RoutingPartLibrary.MatchCriteria and Preferences.RoutingPartLibrary.MatchCriteriaWithFilter .

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe bool NXOpen.Preferences.RoutingPartLibrary.FilterOnCurrentSpecifications	(	NXOpen.Routing.CharacteristicList	match,
		string[]	partClasses
	)

inline

Does a characteristic list match the current discipline and specifications?

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

match	The matching part's Characteristic List to check against the current discipline and specifications.
partClasses	The part class hierarchy list that contains the matching part. The first item in the list is the top node name. The last item in the list is the lowest node that contains the matching part.

Returns: Is the characteristic list valid under the current discipline and specifications?

unsafe string [] NXOpen.Preferences.RoutingPartLibrary.GetChildrenNodes ( string parent )

inline

Returns the children nodes of the input node.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

parent

Returns

unsafe string NXOpen.Preferences.RoutingPartLibrary.GetFilteredRoot ( NXOpen.Preferences.RoutingPartLibrary.RootType rootType )

inline

Returns the root node of the part library using the current active discipline.

Returns a null reference (Nothing in Visual Basic) if there is no root node.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

rootType Which root node to find.

Returns

unsafe NXOpen.Preferences.RoutingPartLibrary.NodeType NXOpen.Preferences.RoutingPartLibrary.GetNodeType ( string node )

inline

Returns the node type.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

node

Returns

unsafe NXOpen.Routing.CharacteristicList NXOpen.Preferences.RoutingPartLibrary.GetPartDefinition ( string node )

inline

Returns the part information for a given NXOpen.Preferences.RoutingPartLibrary.NodeType.Part node.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

node	Must be a NXOpen.Preferences.RoutingPartLibrary.NodeType.Part type node, any other node type causes an exception.

Returns

unsafe string NXOpen.Preferences.RoutingPartLibrary.GetRoot ( )

inline

Returns the root node of the part library.

Returns a null reference (Nothing in Visual Basic) if there is no root node.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.Preferences.RoutingPartLibrary.Column [] NXOpen.Preferences.RoutingPartLibrary.GetTableDefinition ( string node )

inline

Returns the table information for a given NXOpen.Preferences.RoutingPartLibrary.NodeType.Table node.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

node	Must be a NXOpen.Preferences.RoutingPartLibrary.NodeType.Table type node, any other node type causes an exception.

Returns

unsafe NXOpen.Routing.CharacteristicList [] NXOpen.Preferences.RoutingPartLibrary.MatchCriteria	(	string	startNode,
		NXOpen.Routing.CharacteristicList	criteria
	)

inline

Search for entries in the part library table nodes that match the given set of criteria.

Returns an array of NXOpen.Routing.CharacteristicList objects that can be used for assigning stock or placing parts. Searches all nodes at or below the input node for matches.

Performs matches on the name/value pairs in the input critiera, to the column name column values in the part tables below the input node. Ignores names in the input critiera that don't have a corresonding column in the part for matching.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

startNode	Must not be a NXOpen.Preferences.RoutingPartLibrary.NodeType.Part node.
criteria

Returns

unsafe NXOpen.Routing.CharacteristicList [] NXOpen.Preferences.RoutingPartLibrary.MatchCriteriaWithFilter	(	string	startNode,
		NXOpen.Routing.CharacteristicList	criteria
	)

inline

Similar to Preferences.RoutingPartLibrary.MatchCriteria , however it also filters out any parts that don't match the critiera specified by the current specification.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

startNode	Must not be a NXOpen.Preferences.RoutingPartLibrary.NodeType.Part node.
criteria

Returns

Property Documentation

Tag NXOpen.Preferences.RoutingPartLibrary.Tag

get

Returns the tag of this object.

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

Preferences_RoutingPartLibrary.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation