NXOpen::Preferences::RoutingPartLibrary Class Reference

Represents a Routing Part library. More...

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::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...
bool	FilterOnCurrentSpecifications (NXOpen::Routing::CharacteristicList *match, std::vector< NXString > &partClasses)
	Does a characteristic list match the current discipline and specifications? More...
std::vector< NXString >	GetChildrenNodes (const NXString &parent)
	Returns the children nodes of the input node. More...
std::vector< NXString >	GetChildrenNodes (const char *parent)
	Returns the children nodes of the input node. More...
NXString	GetFilteredRoot (NXOpen::Preferences::RoutingPartLibrary::RootType rootType)
	Returns the root node of the part library using the current active discipline. More...
NXOpen::Preferences::RoutingPartLibrary::NodeType	GetNodeType (const NXString &node)
	Returns the node type. More...
NXOpen::Preferences::RoutingPartLibrary::NodeType	GetNodeType (const char *node)
	Returns the node type. More...
NXOpen::Routing::CharacteristicList *	GetPartDefinition (const NXString &node)
	Returns the part information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node. More...
NXOpen::Routing::CharacteristicList *	GetPartDefinition (const char *node)
	Returns the part information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node. More...
NXString	GetRoot ()
	Returns the root node of the part library. More...
std::vector < NXOpen::Preferences::RoutingPartLibrary::Column >	GetTableDefinition (const NXString &node)
	Returns the table information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable node. More...
std::vector < NXOpen::Preferences::RoutingPartLibrary::Column >	GetTableDefinition (const char *node)
	Returns the table information for a given NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable node. More...
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. More...
std::vector < NXOpen::Routing::CharacteristicList * >	MatchCriteria (const char *startNode, NXOpen::Routing::CharacteristicList *criteria)
	Search for entries in the part library table nodes that match the given set of criteria. More...
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. More...
std::vector < NXOpen::Routing::CharacteristicList * >	MatchCriteriaWithFilter (const char *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...
tag_t	Tag () const
	Returns the tag of this object. 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
ColumnStatusNotHidden	Column is displayed in Specify Item.
ColumnStatusHidden	Column is not displayed in Specify Item.

enum NXOpen::Preferences::RoutingPartLibrary::ColumnType

Type of column values.

Enumerator
ColumnTypeInteger	Integer values.
ColumnTypeReal	Floating-point values.
ColumnTypeString	String values.

enum NXOpen::Preferences::RoutingPartLibrary::NodeType

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.

enum NXOpen::Preferences::RoutingPartLibrary::RootType

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

NXOpen::Routing::CharacteristicList* NXOpen::Preferences::RoutingPartLibrary::CreateCriteria

(

)

Creates a new empty NXOpen::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_base ("Routing Basic")

bool NXOpen::Preferences::RoutingPartLibrary::FilterOnCurrentSpecifications	(	NXOpen::Routing::CharacteristicList *	match,
		std::vector< NXString > &	partClasses
	)

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_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.

std::vector<NXString> NXOpen::Preferences::RoutingPartLibrary::GetChildrenNodes

(

const NXString &

parent

)

Returns the children nodes of the input node.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

parent

parent

std::vector<NXString> NXOpen::Preferences::RoutingPartLibrary::GetChildrenNodes

(

const char *

parent

)

Returns the children nodes of the input node.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

parent

parent

NXString NXOpen::Preferences::RoutingPartLibrary::GetFilteredRoot

(

NXOpen::Preferences::RoutingPartLibrary::RootType

rootType

)

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_base ("Routing Basic")

Parameters

rootType

Which root node to find.

NXOpen::Preferences::RoutingPartLibrary::NodeType NXOpen::Preferences::RoutingPartLibrary::GetNodeType

(

const NXString &

node

)

Returns the node type.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

node

node

NXOpen::Preferences::RoutingPartLibrary::NodeType NXOpen::Preferences::RoutingPartLibrary::GetNodeType

(

const char *

node

)

Returns the node type.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

node

node

NXOpen::Routing::CharacteristicList* NXOpen::Preferences::RoutingPartLibrary::GetPartDefinition

(

const NXString &

node

)

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

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

node	Must be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart type node, any other node type causes an exception.

NXOpen::Routing::CharacteristicList* NXOpen::Preferences::RoutingPartLibrary::GetPartDefinition

(

const char *

node

)

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

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

node	Must be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart type node, any other node type causes an exception.

NXString NXOpen::Preferences::RoutingPartLibrary::GetRoot

(

)

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_base ("Routing Basic")

std::vector<NXOpen::Preferences::RoutingPartLibrary::Column> NXOpen::Preferences::RoutingPartLibrary::GetTableDefinition

(

const NXString &

node

)

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

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

node	Must be a NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable type node, any other node type causes an exception.

std::vector<NXOpen::Preferences::RoutingPartLibrary::Column> NXOpen::Preferences::RoutingPartLibrary::GetTableDefinition

(

const char *

node

)

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

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

node	Must be a NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable type node, any other node type causes an exception.

std::vector<NXOpen::Routing::CharacteristicList *> NXOpen::Preferences::RoutingPartLibrary::MatchCriteria	(	const NXString &	startNode,
		NXOpen::Routing::CharacteristicList *	criteria
	)

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.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startNode	Must not be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.
criteria	criteria

std::vector<NXOpen::Routing::CharacteristicList *> NXOpen::Preferences::RoutingPartLibrary::MatchCriteria	(	const char *	startNode,
		NXOpen::Routing::CharacteristicList *	criteria
	)

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.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startNode	Must not be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.
criteria	criteria

std::vector<NXOpen::Routing::CharacteristicList *> NXOpen::Preferences::RoutingPartLibrary::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.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startNode	Must not be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.
criteria	criteria

std::vector<NXOpen::Routing::CharacteristicList *> NXOpen::Preferences::RoutingPartLibrary::MatchCriteriaWithFilter	(	const char *	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.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startNode	Must not be a NXOpen::Preferences::RoutingPartLibrary::NodeTypePart node.
criteria	criteria

tag_t NXOpen::Preferences::RoutingPartLibrary::Tag

(

)

const

Returns the tag of this object.

---

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

• Preferences_RoutingPartLibrary.hxx