Represents a NXOpen.Routing.ReuseLibrary More...

Inheritance diagram for NXOpen.Routing.ReuseLibrary:

Public Types
enum	PartType { Gasket, Bolt, Stud, Nut, Washer, Weldring, Ringjoint, Unknown = -1 }
	Represents the part type. More...

enum	ReportInBom { DoNotReport, Report }
	Represents the report in BOM logical type. More...

Public Member Functions
unsafe void	Reload ()
	Reloads all of the nodes of the Routing Reuse Library based on the current discipline. More...

unsafe void	PartLibraryGetDisciplineRoots (out string[] identifiers, out string[] names)
	Returns the identifiers which represent the start nodes for the current discipline. More...

unsafe void	PartLibraryGetChildNodes (string nodeIdentifier, out string[] childIdentifiers, out string[] names)
	Given an identifier, this routine returns it's child identifiers. More...

unsafe NXOpen.Routing.CharacteristicList	PartLibraryGetPartsAtNode (string nodeIdentifier)
	Given a node identifier, this routine will return all parts associated with that node. More...

unsafe NXOpen.Routing.CharacteristicList[]	GetMatchingParts (string startingIdentifier, NXOpen.Routing.CharacteristicList searchCriteria)
	Query the reuse library for all parts that match the given search criteria. More...

unsafe void	SpecificationsGetDisciplineSpecifications (out string[] specs)
	Returns the names of all of the specifications that are defined for the current discipline. More...

unsafe string	SpecificationsGetCurrent ()
	Returns the name of the current specification. More...

unsafe void	AddNewSpecification (string specName)
	Adds a new empty specification to the library. More...

unsafe void	SpecificationsSetDescription (string specName, string description)
	Sets the description text for a specification. More...

unsafe string	SpecificationsGetDescription (string specName)
	Gets the description of a specification. More...

unsafe void	SpecificationsSetAttributeRelationships (string specName, string nodeIdentifier, NXOpen.Routing.CharacteristicList attributeFilter)
	Sets the attribute relationships for a specification. More...

unsafe NXOpen.Routing.CharacteristicList	SpecificationsGetAttributeRelationships (string specName, string nodeIdentifier, out int numFilters)
	Gets the attribute relationships at a given library node. More...

unsafe void	SpecificationsGetBranchTable (string specName, out double[] npsValues, out double[] npsBranchValues)
	Gets the branch compatibilities for the input specification. More...

unsafe void	SpecificationsSetBranchCompatibility (string specName, double nps, double npsBranch)
	Sets a branch compatibility. More...

unsafe void	SpecificationsRemoveBranchCompatibility (string specName, double nps, double npsBranch)
	Removes a branch compatibility More...

unsafe void	SpecificationsAddConnectionCompatibility (string specName, string connectionTypeOne, string connectionTypeTwo)
	Adds a connection compatibility to the specification. More...

unsafe void	SpecificationsRemoveConnectionCompatibility (string specName, string connectionTypeOne, string connectionTypeTwo)
	Removes a connection compatibility from the specification. More...

unsafe void	SpecificationsGetConnectionCompatibilities (string specName, out string[] connectionTypesOne, out string[] connectionTypesTwo)
	Get the list of connection compatibilities from the specificaiton. More...

unsafe void	SpecificationsSetConnectionPostPlacement (string specName, string connectionTypeOne, string connectionTypeTwo, bool gasket, bool bolt, bool stud, bool nut, bool washers, bool weldRing, bool ringJoints)
	Set Connection post placement rules on a valid connection. More...

unsafe void	SpecificationsGetConnectionPostPlacement (string specName, string connectionTypeOne, string connectionTypeTwo, out bool gasket, out bool bolt, out bool stud, out bool nut, out bool washers, out bool weldRing, out bool ringJoints)
	Get post placement options for a given connection. More...

unsafe void	SpecificationsDefinePostPlacementRules (string specName, NXOpen.Routing.ReuseLibrary.PartType partType, string startingIdentifier, string[] searchAttributes)
	Defines Post Placement rules. More...

unsafe void	SpecificationsGetPostPlacementRules (string specName, NXOpen.Routing.ReuseLibrary.PartType partType, out string startingIdentifier, out string[] searchAttributes)
	Gets post placement rules. More...

unsafe void	SpecificationsSetReportInBom (string specName, bool gasket, bool bolt, bool stud, bool nut, bool washers, bool weldRing, bool ringJoints, bool weldGap)
	Sets the report in BOM flags. More...

unsafe void	SpecificationsGetReportInBom (string specName, out bool gasket, out bool bolt, out bool stud, out bool nut, out bool washers, out bool weldRing, out bool ringJoints, out bool weldGap)
	Gets the Report in BOM flags. More...

unsafe void	SpecificationsSetGeneralConnectionOptions (string specName, bool modelGaskets, bool modelWeldGaps, double additionalBoltLength, double additionalStudLength, double weldGapValue)
	Sets the General Connection Options. More...

unsafe void	SpecificationsGetGeneralConnectionOptions (string specName, out bool modelGaskets, out bool modelWeldGaps, out double additionalBoltLength, out double additionalStudLength, out double weldGapValue)
	Gets the general connection options. More...

unsafe void	SpecificationsAddGenericPostPlacement (string specName, string placedPartIdentifier, string postPlacementIdentifier, string[] searchAttributes)
	Add a generic post placmeent rule. More...

unsafe void	SpecificationsRemoveGenericPostPlacement (string specName, string placedPartIdentifier, string postPlacementIdentifier)
	Remove a generic post placement option. More...

unsafe void	SpecificationsGetGenericPostPlacements (string specName, out string[] placedPartIdentifier, out string[] postPlacementIdentifier)
	Gets the defined generic post placement rules. More...

unsafe void	SpecificationsGetGenericPostPlacementSearchAttributes (string specName, string placedPartIdentifier, string postPlacementIdentifier, out string[] searchAttributes)
	Get the generic post placement search attributes. More...

unsafe void	ReloadSpecifications (bool forceReload)
	Reload Specifications into the reuse library. More...

unsafe void	ReloadSpecification (string specName)
	Reload a Specification into the reuse library. More...

unsafe void	DeleteSpecification (string specName)
	Delete a Specification from the reuse library. More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen.Routing.ReuseLibrary

No creator is available in KF.

Created in NX7.5.3

Member Enumeration Documentation

enum NXOpen.Routing.ReuseLibrary.PartType

Represents the part type.

Enumerator
Gasket	Gasket Post Placement Type
Bolt	Bolt Post Placement Type
Stud	Stud Post Placement Type
Nut	Nut Post Placement Type
Washer	Washer Post Placement Type
Weldring	Weld Ring Post Placement Type
Ringjoint	Ring Joint Post Placement Type
Unknown	Unknown Type

enum NXOpen.Routing.ReuseLibrary.ReportInBom

Represents the report in BOM logical type.

Enumerator
DoNotReport	Do not report in the Bill of Materials
Report	Report in the Bill of Materials

Member Function Documentation

unsafe void NXOpen.Routing.ReuseLibrary.AddNewSpecification ( string specName )

Adds a new empty specification to the library.

The input name can be used to configure the specification once it has been added.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName The name of the new specification.

unsafe void NXOpen.Routing.ReuseLibrary.DeleteSpecification ( string specName )

Delete a Specification from the reuse library.

Created in NX9.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName Specification Name

unsafe NXOpen.Routing.CharacteristicList [] NXOpen.Routing.ReuseLibrary.GetMatchingParts	(	string	startingIdentifier,
		NXOpen.Routing.CharacteristicList	searchCriteria
	)

Query the reuse library for all parts that match the given search criteria.

The search will include the given node and all of its children.

Created in NX8.5.3

License requirements: routing_base ("Routing Basic")

Parameters

startingIdentifier	Node from which to begin the search.
searchCriteria	Search Criteria

Returns: Search Results

unsafe void NXOpen.Routing.ReuseLibrary.PartLibraryGetChildNodes	(	string	nodeIdentifier,
		out string[]	childIdentifiers,
		out string[]	names
	)

Given an identifier, this routine returns it's child identifiers.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

nodeIdentifier	A part library node identifier.
childIdentifiers	The child node identifiers.
names	The discipline start node identifiers.

unsafe void NXOpen.Routing.ReuseLibrary.PartLibraryGetDisciplineRoots	(	out string[]	identifiers,
		out string[]	names
	)

Returns the identifiers which represent the start nodes for the current discipline.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

identifiers	The discipline start node identifiers.
names	The discipline start node identifiers.

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.ReuseLibrary.PartLibraryGetPartsAtNode ( string nodeIdentifier )

Given a node identifier, this routine will return all parts associated with that node.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

nodeIdentifier A part library node identifier.

Returns: An array of parts.

unsafe void NXOpen.Routing.ReuseLibrary.Reload ( )

Reloads all of the nodes of the Routing Reuse Library based on the current discipline.

Created in NX7.5.3

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.ReuseLibrary.ReloadSpecification ( string specName )

Reload a Specification into the reuse library.

Created in NX9.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName Specification Name

unsafe void NXOpen.Routing.ReuseLibrary.ReloadSpecifications ( bool forceReload )

Reload Specifications into the reuse library.

Created in NX9.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

forceReload Should the specifications be forced to reload? Setting forceReload false will reload only if there are no (non-legacy) specifications loaded in the reuse library.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsAddConnectionCompatibility	(	string	specName,
		string	connectionTypeOne,
		string	connectionTypeTwo
	)

Adds a connection compatibility to the specification.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	The name of the specification.
connectionTypeOne	Value of the first CONNECTION_TYPE attribute.
connectionTypeTwo	Value of the second CONNECTION_TYPE attribute.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsAddGenericPostPlacement	(	string	specName,
		string	placedPartIdentifier,
		string	postPlacementIdentifier,
		string[]	searchAttributes
	)

Add a generic post placmeent rule.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name
placedPartIdentifier	The placed part node identifier.
postPlacementIdentifier	The post placement part identifier.
searchAttributes	Attribute search titles.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsDefinePostPlacementRules	(	string	specName,
		NXOpen.Routing.ReuseLibrary.PartType	partType,
		string	startingIdentifier,
		string[]	searchAttributes
	)

Defines Post Placement rules.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name.
partType	Post Placement Type
startingIdentifier	Library Node to search from.
searchAttributes	Search Attribute Titles.

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.ReuseLibrary.SpecificationsGetAttributeRelationships	(	string	specName,
		string	nodeIdentifier,
		out int	numFilters
	)

Gets the attribute relationships at a given library node.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	The name of the specification.
nodeIdentifier	A part library node identifier.
numFilters

Returns: Attribute filters.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetBranchTable	(	string	specName,
		out double[]	npsValues,
		out double[]	npsBranchValues
	)

Gets the branch compatibilities for the input specification.

Compatibilities can be identified by indexing into the NPSValues and NPS_BRANCHValues arrays. Index 0 in each array is a compatibility and so on.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	The name of the specification.
npsValues	The NPS Values.
npsBranchValues	The NPS_BRANCH values.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetConnectionCompatibilities	(	string	specName,
		out string[]	connectionTypesOne,
		out string[]	connectionTypesTwo
	)

Get the list of connection compatibilities from the specificaiton.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification name.
connectionTypesOne	Values for the first CONNECTION_TYPE attribute.
connectionTypesTwo	Values for the second CONNECTION_TYPE attribute.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetConnectionPostPlacement	(	string	specName,
		string	connectionTypeOne,
		string	connectionTypeTwo,
		out bool	gasket,
		out bool	bolt,
		out bool	stud,
		out bool	nut,
		out bool	washers,
		out bool	weldRing,
		out bool	ringJoints
	)

Get post placement options for a given connection.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification name.
connectionTypeOne	The first CONNECTION_TYPE value.
connectionTypeTwo	The second CONNECTION_TYPE value.
gasket	Whether or not to place Gaskets for this connection.
bolt	Whether or not to place Bolts for this connection.
stud	Whether or not to place Studs for this connection.
nut	Whether or not to place Nuts for this connection.
washers	Whether or not to place Washers for this connection.
weldRing	Whether or not to place Weld Rings for this connection.
ringJoints

unsafe string NXOpen.Routing.ReuseLibrary.SpecificationsGetCurrent ( )

Returns the name of the current specification.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: The name of the current specification.

unsafe string NXOpen.Routing.ReuseLibrary.SpecificationsGetDescription ( string specName )

Gets the description of a specification.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName The name of the specification.

Returns: Specification description.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetDisciplineSpecifications ( out string[] specs )

Returns the names of all of the specifications that are defined for the current discipline.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specs Specification names.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetGeneralConnectionOptions	(	string	specName,
		out bool	modelGaskets,
		out bool	modelWeldGaps,
		out double	additionalBoltLength,
		out double	additionalStudLength,
		out double	weldGapValue
	)

Gets the general connection options.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name
modelGaskets	Whether or not to model Gaskets
modelWeldGaps	Whether or not to model Weld Gaps
additionalBoltLength	Additional length for bolts.
additionalStudLength	Additional length for studs
weldGapValue

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetGenericPostPlacements	(	string	specName,
		out string[]	placedPartIdentifier,
		out string[]	postPlacementIdentifier
	)

Gets the defined generic post placement rules.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name.
placedPartIdentifier	The list of placed part node identifiers
postPlacementIdentifier	The list of post placement node identifiers.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetGenericPostPlacementSearchAttributes	(	string	specName,
		string	placedPartIdentifier,
		string	postPlacementIdentifier,
		out string[]	searchAttributes
	)

Get the generic post placement search attributes.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name
placedPartIdentifier	Placed part node identifier.
postPlacementIdentifier	Post placement node identifier
searchAttributes	Attribute search titles.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetPostPlacementRules	(	string	specName,
		NXOpen.Routing.ReuseLibrary.PartType	partType,
		out string	startingIdentifier,
		out string[]	searchAttributes
	)

Gets post placement rules.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification name.
partType	Part Type.
startingIdentifier	Library node to begin searching from.
searchAttributes	Search Attribute Titles.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsGetReportInBom	(	string	specName,
		out bool	gasket,
		out bool	bolt,
		out bool	stud,
		out bool	nut,
		out bool	washers,
		out bool	weldRing,
		out bool	ringJoints,
		out bool	weldGap
	)

Gets the Report in BOM flags.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name
gasket	Report Gaskets
bolt	Report Bolts
stud	Report Studs
nut	Report Nuts
washers	Report Washers
weldRing	Report Weld Rings
ringJoints	Report Ring Joints
weldGap

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsRemoveBranchCompatibility	(	string	specName,
		double	nps,
		double	npsBranch
	)

Removes a branch compatibility

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	The name of the specification.
nps	NPS Value
npsBranch	NPS_BRANCH value

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsRemoveConnectionCompatibility	(	string	specName,
		string	connectionTypeOne,
		string	connectionTypeTwo
	)

Removes a connection compatibility from the specification.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Name of the specification.
connectionTypeOne	Value of the first CONNECTION_TYPE attribute.
connectionTypeTwo	Value of the second CONNECTION_TYPE attribute.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsRemoveGenericPostPlacement	(	string	specName,
		string	placedPartIdentifier,
		string	postPlacementIdentifier
	)

Remove a generic post placement option.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name
placedPartIdentifier	Placed part node identifier.
postPlacementIdentifier

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsSetAttributeRelationships	(	string	specName,
		string	nodeIdentifier,
		NXOpen.Routing.CharacteristicList	attributeFilter
	)

Sets the attribute relationships for a specification.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	The name of the specification.
nodeIdentifier	A part library node identifier.
attributeFilter	Attribute filters.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsSetBranchCompatibility	(	string	specName,
		double	nps,
		double	npsBranch
	)

Sets a branch compatibility.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	The name of the specification.
nps	NPS Value
npsBranch	NPS_BRANCH Vale

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsSetConnectionPostPlacement	(	string	specName,
		string	connectionTypeOne,
		string	connectionTypeTwo,
		bool	gasket,
		bool	bolt,
		bool	stud,
		bool	nut,
		bool	washers,
		bool	weldRing,
		bool	ringJoints
	)

Set Connection post placement rules on a valid connection.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification name.
connectionTypeOne	The first CONNECTION_TYPE value.
connectionTypeTwo	The second CONNECTION_TYPE value.
gasket	Whether or not to place Gaskets for this connection.
bolt	Whether or not to place Bolts for this connection.
stud	Whether or not to place Studs for this connection.
nut	Whether or not to place Nuts for this connection.
washers	Whether or not to place Washers for this connection.
weldRing	Whether or not to place Weld Rings for this connection.
ringJoints

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsSetDescription	(	string	specName,
		string	description
	)

Sets the description text for a specification.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	The name of the specification.
description	The description to add.

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsSetGeneralConnectionOptions	(	string	specName,
		bool	modelGaskets,
		bool	modelWeldGaps,
		double	additionalBoltLength,
		double	additionalStudLength,
		double	weldGapValue
	)

Sets the General Connection Options.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Specification Name
modelGaskets	Whether or not to model Gaskets
modelWeldGaps	Whether or not to model weld gaps.
additionalBoltLength	Additional length to add to bolts
additionalStudLength	Additional length to add to studs
weldGapValue

unsafe void NXOpen.Routing.ReuseLibrary.SpecificationsSetReportInBom	(	string	specName,
		bool	gasket,
		bool	bolt,
		bool	stud,
		bool	nut,
		bool	washers,
		bool	weldRing,
		bool	ringJoints,
		bool	weldGap
	)

Sets the report in BOM flags.

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

specName	Spec Name
gasket	Report Gaskets
bolt	Report Bolts
stud	Report Studs
nut	Report Nuts
washers	Report Washers
weldRing	Report Weld Rings
ringJoints	Report Ring Joints
weldGap

Property Documentation

Tag NXOpen.Routing.ReuseLibrary.Tag

get

Returns the tag of this object.

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

dotnet_pool/Routing_ReuseLibrary.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation