nxopen.preferences

Interface RoutingPartLibrary

All Superinterfaces:

Remote

public interface RoutingPartLibrary
extends Remote

Represents a Routing Part library.
To obtain an instance of this class, refer to RoutingPart

Created in NX4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RoutingPartLibrary.Column Part table column type.
static class	RoutingPartLibrary.ColumnStatus Hidden status of a column.
static class	RoutingPartLibrary.ColumnType Type of column values.
static class	RoutingPartLibrary.NodeType Type of nodes in the part library.
static class	RoutingPartLibrary.RootType Type of root nodes.

Method Summary

Modifier and Type	Method and Description
CharacteristicList	createCriteria() Creates a new empty CharacteristicList object that can be used as input to Preferences.RoutingPartLibrary#matchCriteria and Preferences.RoutingPartLibrary#matchCriteriaWithFilter .
boolean	filterOnCurrentSpecifications(CharacteristicList match, String[] partClasses) Does a characteristic list match the current discipline and specifications?
String[]	getChildrenNodes(String parent) Returns the children nodes of the input node.
String	getFilteredRoot(RoutingPartLibrary.RootType rootType) Returns the root node of the part library using the current active discipline.
RoutingPartLibrary.NodeType	getNodeType(String node) Returns the node type.
CharacteristicList	getPartDefinition(String node) Returns the part information for a given RoutingPartLibrary.NodeType.PART node.
String	getRoot() Returns the root node of the part library.
RoutingPartLibrary.Column[]	getTableDefinition(String node) Returns the table information for a given RoutingPartLibrary.NodeType.TABLE node.
CharacteristicList[]	matchCriteria(String startNode, CharacteristicList criteria) Search for entries in the part library table nodes that match the given set of criteria.
CharacteristicList[]	matchCriteriaWithFilter(String startNode, 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.

Method Detail

getRoot

String getRoot()
        throws NXException,
               RemoteException

Returns the root node of the part library. Returns null if there is no root node.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

getFilteredRoot

String getFilteredRoot(RoutingPartLibrary.RootType rootType)
                throws NXException,
                       RemoteException

Returns the root node of the part library using the current active discipline. Returns null if there is no root node.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

rootType - Which root node to find.

Throws:

NXException

RemoteException

getChildrenNodes

String[] getChildrenNodes(String parent)
                   throws NXException,
                          RemoteException

Returns the children nodes of the input node.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

parent -

Throws:

NXException

RemoteException

getNodeType

RoutingPartLibrary.NodeType getNodeType(String node)
                                 throws NXException,
                                        RemoteException

Returns the node type.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

node -

Throws:

NXException

RemoteException

getTableDefinition

RoutingPartLibrary.Column[] getTableDefinition(String node)
                                        throws NXException,
                                               RemoteException

Returns the table information for a given RoutingPartLibrary.NodeType.TABLE node.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

node - Must be a RoutingPartLibrary.NodeType.TABLE type node, any other node type causes an exception.

Throws:

NXException

RemoteException

getPartDefinition

CharacteristicList getPartDefinition(String node)
                              throws NXException,
                                     RemoteException

Returns the part information for a given RoutingPartLibrary.NodeType.PART node.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

node - Must be a RoutingPartLibrary.NodeType.PART type node, any other node type causes an exception.

Throws:

NXException

RemoteException

createCriteria

CharacteristicList createCriteria()
                           throws NXException,
                                  RemoteException

Creates a new empty CharacteristicList object that can be used as input to Preferences.RoutingPartLibrary#matchCriteria and Preferences.RoutingPartLibrary#matchCriteriaWithFilter .
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

matchCriteria

CharacteristicList[] matchCriteria(String startNode,
                                   CharacteristicList criteria)
                            throws NXException,
                                   RemoteException

Search for entries in the part library table nodes that match the given set of criteria. Returns an array of 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.

License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

startNode - Must not be a RoutingPartLibrary.NodeType.PART node.

criteria -

Throws:

NXException

RemoteException

matchCriteriaWithFilter

CharacteristicList[] matchCriteriaWithFilter(String startNode,
                                             CharacteristicList criteria)
                                      throws NXException,
                                             RemoteException

Similar to Preferences.RoutingPartLibrary#matchCriteria , however it also filters out any parts that don't match the critiera specified by the current specification.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

startNode - Must not be a RoutingPartLibrary.NodeType.PART node.

criteria -

Throws:

NXException

RemoteException

filterOnCurrentSpecifications

boolean filterOnCurrentSpecifications(CharacteristicList match,
                                      String[] partClasses)
                               throws NXException,
                                      RemoteException

Does a characteristic list match the current discipline and specifications?
License requirements: routing_base ("Routing Basic")
.
Created in NX4.0.0

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?

Throws:

NXException

RemoteException