ReuseLibrary Class

class NXOpen.Routing.ReuseLibrary

Bases: object

Represents a NXOpen.Routing.ReuseLibrary

No creator is available in KF.

New in version NX7.5.3.

Methods

Method Description
AddNewSpecification Adds a new empty specification to the library.
DeleteSpecification Delete a Specification from the reuse library.
GetMatchingParts Query the reuse library for all parts that match the given search criteria.
PartLibraryGetChildNodes Given an identifier, this routine returns it’s child identifiers.
PartLibraryGetDisciplineRoots Returns the identifiers which represent the start nodes for the current discipline.
PartLibraryGetPartsAtNode Given a node identifier, this routine will return all parts associated with that node.
Reload Reloads all of the nodes of the Routing Reuse Library based on the current discipline.
ReloadSpecification Reload a Specification into the reuse library.
ReloadSpecifications Reload Specifications into the reuse library.
SpecificationsAddConnectionCompatibility Adds a connection compatibility to the specification.
SpecificationsAddGenericPostPlacement Add a generic post placmeent rule.
SpecificationsDefinePostPlacementRules Defines Post Placement rules.
SpecificationsGetAttributeRelationships Gets the attribute relationships at a given library node.
SpecificationsGetBranchTable Gets the branch compatibilities for the input specification.
SpecificationsGetConnectionCompatibilities Get the list of connection compatibilities from the specificaiton.
SpecificationsGetConnectionPostPlacement Get post placement options for a given connection.
SpecificationsGetCurrent Returns the name of the current specification.
SpecificationsGetDescription Gets the description of a specification.
SpecificationsGetDisciplineSpecifications Returns the names of all of the specifications that are defined for the current discipline.
SpecificationsGetGeneralConnectionOptions Gets the general connection options.
SpecificationsGetGenericPostPlacementSearchAttributes Get the generic post placement search attributes.
SpecificationsGetGenericPostPlacements Gets the defined generic post placement rules.
SpecificationsGetPostPlacementRules Gets post placement rules.
SpecificationsGetReportInBom Gets the Report in BOM flags.
SpecificationsRemoveBranchCompatibility Removes a branch compatibility
SpecificationsRemoveConnectionCompatibility Removes a connection compatibility from the specification.
SpecificationsRemoveGenericPostPlacement Remove a generic post placement option.
SpecificationsSetAttributeRelationships Sets the attribute relationships for a specification.
SpecificationsSetBranchCompatibility Sets a branch compatibility.
SpecificationsSetConnectionPostPlacement Set Connection post placement rules on a valid connection.
SpecificationsSetDescription Sets the description text for a specification.
SpecificationsSetGeneralConnectionOptions Sets the General Connection Options.
SpecificationsSetReportInBom Sets the report in BOM flags.

Enumerations

ReuseLibraryPartType Enumeration Represents the part type.
ReuseLibraryReportInBom Enumeration Represents the report in BOM logical type.

Method Detail

AddNewSpecification

ReuseLibrary.AddNewSpecification

Adds a new empty specification to the library.

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

Signature AddNewSpecification(specName)

Parameters:specName (str) – The name of the new specification.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

DeleteSpecification

ReuseLibrary.DeleteSpecification

Delete a Specification from the reuse library.

Signature DeleteSpecification(specName)

Parameters:specName (str) – Specification Name

New in version NX9.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetMatchingParts

ReuseLibrary.GetMatchingParts

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.

Signature GetMatchingParts(startingIdentifier, searchCriteria)

Parameters:
Returns:

Search Results
Return type:

list of NXOpen.Routing.CharacteristicList

New in version NX8.5.3.

License requirements: routing_base (“Routing Basic”)

PartLibraryGetChildNodes

ReuseLibrary.PartLibraryGetChildNodes

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

Signature PartLibraryGetChildNodes(nodeIdentifier)

Parameters:nodeIdentifier (str) – A part library node identifier.
Returns:a tuple
Return type:A tuple consisting of (childIdentifiers, names) childIdentifiers is a list of str. The child node identifiers. names is a list of str. The discipline start node identifiers.

New in version NX8.0.0.

License requirements: routing_base (“Routing Basic”)

PartLibraryGetDisciplineRoots

ReuseLibrary.PartLibraryGetDisciplineRoots

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

Signature PartLibraryGetDisciplineRoots()

Returns:a tuple
Return type:A tuple consisting of (identifiers, names) identifiers is a list of str. The discipline start node identifiers.names is a list of str. The discipline start node identifiers.

New in version NX8.0.0.

License requirements: routing_base (“Routing Basic”)

PartLibraryGetPartsAtNode

ReuseLibrary.PartLibraryGetPartsAtNode

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

Signature PartLibraryGetPartsAtNode(nodeIdentifier)

Parameters:nodeIdentifier (str) – A part library node identifier.
Returns:An array of parts.
Return type:NXOpen.Routing.CharacteristicList

New in version NX8.0.0.

License requirements: routing_base (“Routing Basic”)

Reload

ReuseLibrary.Reload

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

Signature Reload()

New in version NX7.5.3.

License requirements: routing_base (“Routing Basic”)

ReloadSpecification

ReuseLibrary.ReloadSpecification

Reload a Specification into the reuse library.

Signature ReloadSpecification(specName)

Parameters:specName (str) – Specification Name

New in version NX9.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

ReloadSpecifications

ReuseLibrary.ReloadSpecifications

Reload Specifications into the reuse library.

Signature ReloadSpecifications(forceReload)

Parameters:forceReload (bool) – 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.

New in version NX9.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsAddConnectionCompatibility

ReuseLibrary.SpecificationsAddConnectionCompatibility

Adds a connection compatibility to the specification.

Signature SpecificationsAddConnectionCompatibility(specName, connectionTypeOne, connectionTypeTwo)

Parameters:
  • specName (str) – The name of the specification.
  • connectionTypeOne (str) – Value of the first CONNECTION_TYPE attribute.
  • connectionTypeTwo (str) – Value of the second CONNECTION_TYPE attribute.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsAddGenericPostPlacement

ReuseLibrary.SpecificationsAddGenericPostPlacement

Add a generic post placmeent rule.

Signature SpecificationsAddGenericPostPlacement(specName, placedPartIdentifier, postPlacementIdentifier, searchAttributes)

Parameters:
  • specName (str) – Specification Name
  • placedPartIdentifier (str) – The placed part node identifier.
  • postPlacementIdentifier (str) – The post placement part identifier.
  • searchAttributes (list of str) – Attribute search titles.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsDefinePostPlacementRules

ReuseLibrary.SpecificationsDefinePostPlacementRules

Defines Post Placement rules.

Signature SpecificationsDefinePostPlacementRules(specName, partType, startingIdentifier, searchAttributes)

Parameters:
  • specName (str) – Specification Name.
  • partType (NXOpen.Routing.ReuseLibraryPartType) – Post Placement Type
  • startingIdentifier (str) – Library Node to search from.
  • searchAttributes (list of str) – Search Attribute Titles.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetAttributeRelationships

ReuseLibrary.SpecificationsGetAttributeRelationships

Gets the attribute relationships at a given library node.

Signature SpecificationsGetAttributeRelationships(specName, nodeIdentifier)

Parameters:
  • specName (str) – The name of the specification.
  • nodeIdentifier (str) – A part library node identifier.
Returns:

a tuple
Return type:

A tuple consisting of (attributeFilter, numFilters). attributeFilter is a NXOpen.Routing.CharacteristicList. Attribute filters. numFilters is a int.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetBranchTable

ReuseLibrary.SpecificationsGetBranchTable

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.

Signature SpecificationsGetBranchTable(specName)

Parameters:specName (str) – The name of the specification.
Returns:a tuple
Return type:A tuple consisting of (npsValues, npsBranchValues) npsValues is a list of float. The NPS Values. npsBranchValues is a list of float. The NPS_BRANCH values.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetConnectionCompatibilities

ReuseLibrary.SpecificationsGetConnectionCompatibilities

Get the list of connection compatibilities from the specificaiton.

Signature SpecificationsGetConnectionCompatibilities(specName)

Parameters:specName (str) – Specification name.
Returns:a tuple
Return type:A tuple consisting of (connectionTypesOne, connectionTypesTwo) connectionTypesOne is a list of str. Values for the first CONNECTION_TYPE attribute. connectionTypesTwo is a list of str. Values for the second CONNECTION_TYPE attribute.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetConnectionPostPlacement

ReuseLibrary.SpecificationsGetConnectionPostPlacement

Get post placement options for a given connection.

Signature SpecificationsGetConnectionPostPlacement(specName, connectionTypeOne, connectionTypeTwo)

Parameters:
  • specName (str) – Specification name.
  • connectionTypeOne (str) – The first CONNECTION_TYPE value.
  • connectionTypeTwo (str) – The second CONNECTION_TYPE value.
Returns:

a tuple
Return type:

A tuple consisting of (gasket, bolt, stud, nut, washers, weldRing, ringJoints) gasket is a bool. Whether or not to place Gaskets for this connection. bolt is a bool. Whether or not to place Bolts for this connection. stud is a bool. Whether or not to place Studs for this connection. nut is a bool. Whether or not to place Nuts for this connection. washers is a bool. Whether or not to place Washers for this connection. weldRing is a bool. Whether or not to place Weld Rings for this connection. ringJoints is a bool.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetCurrent

ReuseLibrary.SpecificationsGetCurrent

Returns the name of the current specification.

Signature SpecificationsGetCurrent()

Returns:The name of the current specification.
Return type:str

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetDescription

ReuseLibrary.SpecificationsGetDescription

Gets the description of a specification.

Signature SpecificationsGetDescription(specName)

Parameters:specName (str) – The name of the specification.
Returns:Specification description.
Return type:str

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetDisciplineSpecifications

ReuseLibrary.SpecificationsGetDisciplineSpecifications

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

Signature SpecificationsGetDisciplineSpecifications()

Returns:Specification names.
Return type:list of str

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetGeneralConnectionOptions

ReuseLibrary.SpecificationsGetGeneralConnectionOptions

Gets the general connection options.

Signature SpecificationsGetGeneralConnectionOptions(specName)

Parameters:specName (str) – Specification Name
Returns:a tuple
Return type:A tuple consisting of (modelGaskets, modelWeldGaps, additionalBoltLength, additionalStudLength, weldGapValue) modelGaskets is a bool. Whether or not to model Gaskets modelWeldGaps is a bool. Whether or not to model Weld Gaps additionalBoltLength is a float. Additional length for bolts. additionalStudLength is a float. Additional length for studsweldGapValue is a float.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetGenericPostPlacementSearchAttributes

ReuseLibrary.SpecificationsGetGenericPostPlacementSearchAttributes

Get the generic post placement search attributes.

Signature SpecificationsGetGenericPostPlacementSearchAttributes(specName, placedPartIdentifier, postPlacementIdentifier)

Parameters:
  • specName (str) – Specification Name
  • placedPartIdentifier (str) – Placed part node identifier.
  • postPlacementIdentifier (str) – Post placement node identifier
Returns:

Attribute search titles.
Return type:

list of str

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetGenericPostPlacements

ReuseLibrary.SpecificationsGetGenericPostPlacements

Gets the defined generic post placement rules.

Signature SpecificationsGetGenericPostPlacements(specName)

Parameters:specName (str) – Specification Name.
Returns:a tuple
Return type:A tuple consisting of (placedPartIdentifier, postPlacementIdentifier) placedPartIdentifier is a list of str. The list of placed part node identifiers postPlacementIdentifier is a list of str. The list of post placement node identifiers.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetPostPlacementRules

ReuseLibrary.SpecificationsGetPostPlacementRules

Gets post placement rules.

Signature SpecificationsGetPostPlacementRules(specName, partType)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (startingIdentifier, searchAttributes) startingIdentifier is a str. Library node to begin searching from. searchAttributes is a list of str. Search Attribute Titles.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsGetReportInBom

ReuseLibrary.SpecificationsGetReportInBom

Gets the Report in BOM flags.

Signature SpecificationsGetReportInBom(specName)

Parameters:specName (str) – Specification Name
Returns:a tuple
Return type:A tuple consisting of (gasket, bolt, stud, nut, washers, weldRing, ringJoints, weldGap) gasket is a bool. Report Gaskets bolt is a bool. Report Bolts stud is a bool. Report Studsnut is a bool. Report Nutswashers is a bool. Report WashersweldRing is a bool. Report Weld RingsringJoints is a bool. Report Ring JointsweldGap is a bool.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsRemoveBranchCompatibility

ReuseLibrary.SpecificationsRemoveBranchCompatibility

Removes a branch compatibility

Signature SpecificationsRemoveBranchCompatibility(specName, nps, npsBranch)

Parameters:
  • specName (str) – The name of the specification.
  • nps (float) – NPS Value
  • npsBranch (float) – NPS_BRANCH value

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsRemoveConnectionCompatibility

ReuseLibrary.SpecificationsRemoveConnectionCompatibility

Removes a connection compatibility from the specification.

Signature SpecificationsRemoveConnectionCompatibility(specName, connectionTypeOne, connectionTypeTwo)

Parameters:
  • specName (str) – Name of the specification.
  • connectionTypeOne (str) – Value of the first CONNECTION_TYPE attribute.
  • connectionTypeTwo (str) – Value of the second CONNECTION_TYPE attribute.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsRemoveGenericPostPlacement

ReuseLibrary.SpecificationsRemoveGenericPostPlacement

Remove a generic post placement option.

Signature SpecificationsRemoveGenericPostPlacement(specName, placedPartIdentifier, postPlacementIdentifier)

Parameters:
  • specName (str) – Specification Name
  • placedPartIdentifier (str) – Placed part node identifier.
  • postPlacementIdentifier (str) –

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsSetAttributeRelationships

ReuseLibrary.SpecificationsSetAttributeRelationships

Sets the attribute relationships for a specification.

Signature SpecificationsSetAttributeRelationships(specName, nodeIdentifier, attributeFilter)

Parameters:
  • specName (str) – The name of the specification.
  • nodeIdentifier (str) – A part library node identifier.
  • attributeFilter (NXOpen.Routing.CharacteristicList) – Attribute filters.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsSetBranchCompatibility

ReuseLibrary.SpecificationsSetBranchCompatibility

Sets a branch compatibility.

Signature SpecificationsSetBranchCompatibility(specName, nps, npsBranch)

Parameters:
  • specName (str) – The name of the specification.
  • nps (float) – NPS Value
  • npsBranch (float) – NPS_BRANCH Vale

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsSetConnectionPostPlacement

ReuseLibrary.SpecificationsSetConnectionPostPlacement

Set Connection post placement rules on a valid connection.

Signature SpecificationsSetConnectionPostPlacement(specName, connectionTypeOne, connectionTypeTwo, gasket, bolt, stud, nut, washers, weldRing, ringJoints)

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

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsSetDescription

ReuseLibrary.SpecificationsSetDescription

Sets the description text for a specification.

Signature SpecificationsSetDescription(specName, description)

Parameters:
  • specName (str) – The name of the specification.
  • description (str) – The description to add.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsSetGeneralConnectionOptions

ReuseLibrary.SpecificationsSetGeneralConnectionOptions

Sets the General Connection Options.

Signature SpecificationsSetGeneralConnectionOptions(specName, modelGaskets, modelWeldGaps, additionalBoltLength, additionalStudLength, weldGapValue)

Parameters:
  • specName (str) – Specification Name
  • modelGaskets (bool) – Whether or not to model Gaskets
  • modelWeldGaps (bool) – Whether or not to model weld gaps.
  • additionalBoltLength (float) – Additional length to add to bolts
  • additionalStudLength (float) – Additional length to add to studs
  • weldGapValue (float) –

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SpecificationsSetReportInBom

ReuseLibrary.SpecificationsSetReportInBom

Sets the report in BOM flags.

Signature SpecificationsSetReportInBom(specName, gasket, bolt, stud, nut, washers, weldRing, ringJoints, weldGap)

Parameters:
  • specName (str) – Spec Name
  • gasket (bool) – Report Gaskets
  • bolt (bool) – Report Bolts
  • stud (bool) – Report Studs
  • nut (bool) – Report Nuts
  • washers (bool) – Report Washers
  • weldRing (bool) – Report Weld Rings
  • ringJoints (bool) – Report Ring Joints
  • weldGap (bool) –

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)