RelinkerBuilder Class

class NXOpen.Assemblies.RelinkerBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Assemblies.RelinkerBuilder

To create a new instance of this class, use NXOpen.Assemblies.RelinkerCollection.CreateBuilder()

New in version NX5.0.0.

Properties

Property Description
BreakInterpartExpression Returns or sets the option to break interpart expression.
BreakWaveLink Returns or sets the option to break WAVE links.
FaceCurveDirectionAdjustment Returns or sets the option to adjust face or curve direction.
IncludeNonBrokenWaveLinks Returns or sets the option to include non-broken WAVE links or not.
IncludeSuppressedComponents Returns or sets the option to include suppressed components as source candidates or not.
RelinkCategory Returns or sets the relink category either wave geometry or interpart expression.
RelinkOption Returns or sets the link option.
RelinkType Returns or sets the current link type.
SearchExistingInterPartExpressionOnly Returns or sets the option to search existing inter part expression only or all expressions including regular ones.
SearchingDestinationObject Returns or sets the searching destination object string.
SearchingSourceObject Returns or sets the searching source object string.
SearchingSourcePart Returns or sets the searching source part string.
SearchingSourcePartAttribute Returns or sets the searching source part attribute string.
SelectComponent Returns a list of the selected component as relink target scope.
SelectComponentSource Returns a list of the selected component as relink source scope.
SourceScope Returns or sets the current source scope.
Tag Returns the Tag for this object.
TargetScope Returns or sets the current target scope.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
ExecuteRelink Relink with new source, for WAVE links, interpart explression or both.
ExportToInformationWindow List all link information to the list window.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetExpressionSourceCount Gets the total count of multiple candidate sources to re-parent the inter part expression.
GetObject Returns the object currently being edited by this builder.
RelinkInterpartExpression Relinks the inter part expression using the specific expression from the specific part in case of multiple expression sources.
RelinkWaveFeature Relinks the wave feature using the specific geometry source from the specific part in case of multiple geometry sources.
SearchWavelinksInterpartExpressions Searches WAVE links and interpart expressions.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateSession Updates the session.
UpdateSessionWithBreakDelayed Updates the session without immediately breaking wave links or inter part expressions.
Validate Validate whether the inputs to the component are sufficient for commit to be called.
ViewFeatureFailure Views the feature failure information.

Enumerations

RelinkerBuilderLinkCategory Enumeration Represents the link category of Relinker, either geometry WAVE link or interpart expression.
RelinkerBuilderLinkOption Enumeration Represents the relink option.
RelinkerBuilderLinkScope Enumeration Represents the relink scope type of Relinker.
RelinkerBuilderLinkType Enumeration Represents the link type option when browsing current available links.

Property Detail

BreakInterpartExpression

RelinkerBuilder.BreakInterpartExpression

Returns or sets the option to break interpart expression.

If it’s true, relinker will break interpart expression after relinking. If it’s false, relinker will not break interpart expression.

-------------------------------------

Getter Method

Signature BreakInterpartExpression

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BreakInterpartExpression

Parameters:breakInterPartExpression (bool) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

FaceCurveDirectionAdjustment

RelinkerBuilder.FaceCurveDirectionAdjustment

Returns or sets the option to adjust face or curve direction.

If it’s true, relinker will check the linked curve direction or face normal and either keep or automatically flip the direction of new source while relinking.

-------------------------------------

Getter Method

Signature FaceCurveDirectionAdjustment

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FaceCurveDirectionAdjustment

Parameters:adjustDir (bool) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

IncludeSuppressedComponents

RelinkerBuilder.IncludeSuppressedComponents

Returns or sets the option to include suppressed components as source candidates or not.

If it’s true, relinker will include suppressed components as source candidates. If it’s false, suppressed components will not be included as source candidates while relinking. The default behavior in the relinker is not to include suppressed components.

-------------------------------------

Getter Method

Signature IncludeSuppressedComponents

Returns:
Return type:bool

New in version NX5.0.2.

License requirements: None.

-------------------------------------

Setter Method

Signature IncludeSuppressedComponents

Parameters:includeSuppressedComponents (bool) –

New in version NX5.0.2.

License requirements: wave (“WAVE FUNCTIONALITY”)

RelinkCategory

RelinkerBuilder.RelinkCategory

Returns or sets the relink category either wave geometry or interpart expression.

-------------------------------------

Getter Method

Signature RelinkCategory

Returns:
Return type:NXOpen.Assemblies.RelinkerBuilderLinkCategory

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RelinkCategory

Parameters:linkCategory (NXOpen.Assemblies.RelinkerBuilderLinkCategory) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

RelinkOption

RelinkerBuilder.RelinkOption

Returns or sets the link option.

Relinker will check this option to relink WAVE, interpart expression or both

-------------------------------------

Getter Method

Signature RelinkOption

Returns:
Return type:NXOpen.Assemblies.RelinkerBuilderLinkOption

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RelinkOption

Parameters:linkOption (NXOpen.Assemblies.RelinkerBuilderLinkOption) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

RelinkType

RelinkerBuilder.RelinkType

Returns or sets the current link type.

-------------------------------------

Getter Method

Signature RelinkType

Returns:
Return type:NXOpen.Assemblies.RelinkerBuilderLinkType

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RelinkType

Parameters:linkType (NXOpen.Assemblies.RelinkerBuilderLinkType) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SearchExistingInterPartExpressionOnly

RelinkerBuilder.SearchExistingInterPartExpressionOnly

Returns or sets the option to search existing inter part expression only or all expressions including regular ones.

-------------------------------------

Getter Method

Signature SearchExistingInterPartExpressionOnly

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SearchExistingInterPartExpressionOnly

Parameters:searchExistingIPEOnly (bool) –

New in version NX11.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SearchingDestinationObject

RelinkerBuilder.SearchingDestinationObject

Returns or sets the searching destination object string.

Used to specify the wildcard string to search the destination objects when cycling object by name. When cycling destination objects, relink scope will be used as the searching scope.

-------------------------------------

Getter Method

Signature SearchingDestinationObject

Returns:
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SearchingDestinationObject

Parameters:destinationObjectStr (str) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SearchingSourceObject

RelinkerBuilder.SearchingSourceObject

Returns or sets the searching source object string.

Used to specify the wildcard string to search the source objects when cycling object by name. When cycling source objects, source parts will define the searching scope.

-------------------------------------

Getter Method

Signature SearchingSourceObject

Returns:
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SearchingSourceObject

Parameters:sourceObjectStr (str) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SearchingSourcePart

RelinkerBuilder.SearchingSourcePart

Returns or sets the searching source part string.

Used to specify the wildcard string to search source parts by file names. Source parts define the scope of searching source objects.

-------------------------------------

Getter Method

Signature SearchingSourcePart

Returns:
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SearchingSourcePart

Parameters:sourcePartStr (str) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SearchingSourcePartAttribute

RelinkerBuilder.SearchingSourcePartAttribute

Returns or sets the searching source part attribute string.

Used to specify the wildcard string to search source parts by part attribute predefined in source part. This criterial will furtherly narrow down the source part scope to avoid multiple source found.

-------------------------------------

Getter Method

Signature SearchingSourcePartAttribute

Returns:
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SearchingSourcePartAttribute

Parameters:sourcePartAttribute (str) –

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SelectComponent

RelinkerBuilder.SelectComponent

Returns a list of the selected component as relink target scope.

-------------------------------------

Getter Method

Signature SelectComponent

Returns:
Return type:NXOpen.Assemblies.SelectComponentList

New in version NX5.0.0.

License requirements: None.

SelectComponentSource

RelinkerBuilder.SelectComponentSource

Returns a list of the selected component as relink source scope.

-------------------------------------

Getter Method

Signature SelectComponentSource

Returns:
Return type:NXOpen.Assemblies.SelectComponentList

New in version NX6.0.2.

License requirements: None.

SourceScope

RelinkerBuilder.SourceScope

Returns or sets the current source scope.

-------------------------------------

Getter Method

Signature SourceScope

Returns:
Return type:NXOpen.Assemblies.RelinkerBuilderLinkScope

New in version NX5.0.2.

License requirements: None.

-------------------------------------

Setter Method

Signature SourceScope

Parameters:sourceScope (NXOpen.Assemblies.RelinkerBuilderLinkScope) –

New in version NX5.0.2.

License requirements: wave (“WAVE FUNCTIONALITY”)

TargetScope

RelinkerBuilder.TargetScope

Returns or sets the current target scope.

-------------------------------------

Getter Method

Signature TargetScope

Returns:
Return type:NXOpen.Assemblies.RelinkerBuilderLinkScope

New in version NX5.0.2.

License requirements: None.

-------------------------------------

Setter Method

Signature TargetScope

Parameters:targetScope (NXOpen.Assemblies.RelinkerBuilderLinkScope) –

New in version NX5.0.2.

License requirements: wave (“WAVE FUNCTIONALITY”)

Method Detail

ExportToInformationWindow

RelinkerBuilder.ExportToInformationWindow

List all link information to the list window.

Signature ExportToInformationWindow()

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

GetExpressionSourceCount

RelinkerBuilder.GetExpressionSourceCount

Gets the total count of multiple candidate sources to re-parent the inter part expression.

Signature GetExpressionSourceCount(partID, expID, sourceID)

Parameters:
Returns:
Return type:

int

New in version NX7.5.5.

License requirements: wave (“WAVE FUNCTIONALITY”)

RelinkInterpartExpression

RelinkerBuilder.RelinkInterpartExpression

Relinks the inter part expression using the specific expression from the specific part in case of multiple expression sources.

Signature RelinkInterpartExpression(partID, expID, sourceID)

Parameters:

New in version NX7.5.5.

License requirements: wave (“WAVE FUNCTIONALITY”)

RelinkWaveFeature

RelinkerBuilder.RelinkWaveFeature

Relinks the wave feature using the specific geometry source from the specific part in case of multiple geometry sources.

Signature RelinkWaveFeature(partID, featID, sourceID)

Parameters:

New in version NX7.5.5.

License requirements: wave (“WAVE FUNCTIONALITY”)

SearchWavelinksInterpartExpressions

RelinkerBuilder.SearchWavelinksInterpartExpressions

Searches WAVE links and interpart expressions.

This method does not actually change the link data and interpart expressions.

Signature SearchWavelinksInterpartExpressions()

New in version NX10.0.3.

License requirements: wave (“WAVE FUNCTIONALITY”)

UpdateSession

RelinkerBuilder.UpdateSession

Updates the session.

Signature UpdateSession()

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

UpdateSessionWithBreakDelayed

RelinkerBuilder.UpdateSessionWithBreakDelayed

Updates the session without immediately breaking wave links or inter part expressions.

Signature UpdateSessionWithBreakDelayed()

New in version NX8.5.1.

License requirements: wave (“WAVE FUNCTIONALITY”)

Validate

RelinkerBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.

ViewFeatureFailure

RelinkerBuilder.ViewFeatureFailure

Views the feature failure information.

All failed features in assembly will be shown with detailed information.

Signature ViewFeatureFailure()

New in version NX5.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)