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

Represents a Routing Part library. More...

List of all members.

Classes

struct  Column
 Part table column type. More...

Public Types

enum  ColumnStatus { ColumnStatusNotHidden, ColumnStatusHidden }
 Hidden status of a column. More...
enum  ColumnType { ColumnTypeInteger, ColumnTypeReal, ColumnTypeString = 4 }
 Type of column values. More...
enum  NodeType { NodeTypeNormal, NodeTypeTable, NodeTypePart }
 Type of nodes in the part library. More...
enum  RootType { RootTypeTop, RootTypeStock, RootTypeWire, RootTypePart }
 Type of root nodes. More...

Public Member Functions

NXOpen::Routing::CharacteristicListCreateCriteria ()
 Creates a new empty Routing::CharacteristicList object that can be used as input to Preferences::RoutingPartLibrary::MatchCriteria and Preferences::RoutingPartLibrary::MatchCriteriaWithFilter .
bool FilterOnCurrentSpecifications (NXOpen::Routing::CharacteristicList *match, std::vector< NXString > &partClasses)
 Does a characteristic list match the current discipline and specifications?
std::vector< NXStringGetChildrenNodes (const NXString &parent)
 Returns the children nodes of the input node.
NXString GetFilteredRoot (NXOpen::Preferences::RoutingPartLibrary::RootType rootType)
 Returns the root node of the part library using the current active discipline.
NXOpen::Preferences::RoutingPartLibrary::NodeType GetNodeType (const NXString &node)
 Returns the node type.
NXOpen::Routing::CharacteristicListGetPartDefinition (const NXString &node)
 Returns the part information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.
NXString GetRoot ()
 Returns the root node of the part library.
std::vector
< NXOpen::Preferences::RoutingPartLibrary::Column
GetTableDefinition (const NXString &node)
 Returns the table information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable node.
std::vector
< NXOpen::Routing::CharacteristicList * > 
MatchCriteria (const NXString &startNode, NXOpen::Routing::CharacteristicList *criteria)
 Search for entries in the part library table nodes that match the given set of criteria.
std::vector
< NXOpen::Routing::CharacteristicList * > 
MatchCriteriaWithFilter (const NXString &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.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents a Routing Part library.


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

Created in NX4.0.0.


Member Enumeration Documentation

Hidden status of a column.

Enumerator:
ColumnStatusNotHidden 

Column is displayed in Specify Item.

ColumnStatusHidden 

Column is not displayed in Specify Item.

Type of column values.

Enumerator:
ColumnTypeInteger 

Integer values.

ColumnTypeReal 

Floating-point values.

Type of nodes in the part library.

Enumerator:
NodeTypeNormal 

Normal node, may contain part table children.

Doesn't have any part table information.

NodeTypeTable 

Part table node.

Contains columns/rows that specify parts.

NodeTypePart 

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

Type of root nodes.

Enumerator:
RootTypeTop 

Top of entire part table.

RootTypeStock 

Top node for selecting stocks.

RootTypeWire 

Top node for selecting wires.

RootTypePart 

Top node for selecting parts.


Member Function Documentation

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

Returns:

Created in NX4.0.0.

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

Does a characteristic list match the current discipline and specifications?

Returns:
Is the characteristic list valid under the current discipline and specifications?
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
matchThe matching part's Characteristic List to check against the current discipline and specifications.
partClassesThe 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.
NOTE: The full Unicode character set is not supported for this parameter.

Returns the children nodes of the input node.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
parent
NOTE: The full Unicode character set is not supported for this parameter.

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

Returns NULL if there is no root node.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
rootTypeWhich root node to find.

Returns the node type.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
node
NOTE: The full Unicode character set is not supported for this parameter.

Returns the part information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
nodeMust be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart type node, any other node type causes an exception.
NOTE: The full Unicode character set is not supported for this parameter.

Returns the root node of the part library.

Returns NULL if there is no root node.

Returns:

Created in NX4.0.0.

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

Returns the table information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable node.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
nodeMust be a NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable type node, any other node type causes an exception.
NOTE: The full Unicode character set is not supported for this parameter.

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

Returns an array of 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.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startNodeMust not be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.
NOTE: The full Unicode character set is not supported for this parameter.
criteriacriteria

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startNodeMust not be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.
NOTE: The full Unicode character set is not supported for this parameter.
criteriacriteria

Returns the tag of this object.


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