NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Assemblies.RelinkerBuilder Class Reference

Represents a NXOpen.Assemblies.RelinkerBuilder More...

Inheritance diagram for NXOpen.Assemblies.RelinkerBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  LinkCategory { WaveGeometry, InterpartExpression }
 Represents the link category of Relinker, either geometry WAVE link or interpart expression. More...
 
enum  LinkOption { InterpartExpression, WaveGeometry, Both }
 Represents the relink option. More...
 
enum  LinkScope { PartsInSession, PartsInAssembly, WorkPart, SelectedParts }
 Represents the relink scope type of Relinker. More...
 
enum  LinkType {
  All, NotBroken, Broken, AutoLinked,
  WithMultipleSource
}
 Represents the link type option when browsing current available links. More...
 

Public Member Functions

unsafe void ExecuteRelink ()
 Relink with new source, for WAVE links, interpart explression or both. More...
 
unsafe void ExportToInformationWindow ()
 List all link information to the list window. More...
 
unsafe int GetExpressionSourceCount (NXOpen.Part partID, NXOpen.Expression expID, NXOpen.Expression sourceID)
 Gets the total count of multiple candidate sources to re-parent the inter part expression. More...
 
unsafe void RelinkInterpartExpression (NXOpen.Part partID, NXOpen.Expression expID, NXOpen.Expression sourceID)
 Relinks the inter part expression using the specific expression from the specific part in case of multiple expression sources. More...
 
unsafe void RelinkWaveFeature (NXOpen.Part partID, NXOpen.Features.Feature featID, NXOpen.NXObject sourceID)
 Relinks the wave feature using the specific geometry source from the specific part in case of multiple geometry sources. More...
 
unsafe void SearchWavelinksInterpartExpressions ()
 Searches WAVE links and interpart expressions. More...
 
unsafe void UpdateSession ()
 Updates the session. More...
 
unsafe void UpdateSessionWithBreakDelayed ()
 Updates the session without immediately breaking wave links or inter part expressions. More...
 
unsafe void ViewFeatureFailure ()
 Views the feature failure information. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool BreakInterpartExpression [get, set]
 Returns or sets the option to break interpart expression. More...
 
unsafe bool BreakWaveLink [get, set]
 Returns or sets the option to break WAVE links. More...
 
unsafe bool FaceCurveDirectionAdjustment [get, set]
 Returns or sets the option to adjust face or curve direction. More...
 
unsafe bool IncludeNonBrokenWaveLinks [get, set]
 Returns or sets the option to include non-broken WAVE links or not. More...
 
unsafe bool IncludeSuppressedComponents [get, set]
 Returns or sets the option to include suppressed components as source candidates or not. More...
 
unsafe
NXOpen.Assemblies.RelinkerBuilder.LinkCategory 
RelinkCategory [get, set]
 Returns or sets the relink category either wave geometry or interpart expression. More...
 
unsafe
NXOpen.Assemblies.RelinkerBuilder.LinkOption 
RelinkOption [get, set]
 Returns or sets the link option. More...
 
unsafe
NXOpen.Assemblies.RelinkerBuilder.LinkType 
RelinkType [get, set]
 Returns or sets the current link type. More...
 
unsafe bool SearchExistingInterPartExpressionOnly [get, set]
 Returns or sets the option to search existing inter part expression only or all expressions including regular ones. More...
 
unsafe string SearchingDestinationObject [get, set]
 Returns or sets the searching destination object string. More...
 
unsafe string SearchingSourceObject [get, set]
 Returns or sets the searching source object string. More...
 
unsafe string SearchingSourcePart [get, set]
 Returns or sets the searching source part string. More...
 
unsafe string SearchingSourcePartAttribute [get, set]
 Returns or sets the searching source part attribute string. More...
 
unsafe
NXOpen.Assemblies.SelectComponentList 
SelectComponent [get]
 Returns a list of the selected component as relink target scope. More...
 
unsafe
NXOpen.Assemblies.SelectComponentList 
SelectComponentSource [get]
 Returns a list of the selected component as relink source scope. More...
 
unsafe
NXOpen.Assemblies.RelinkerBuilder.LinkScope 
SourceScope [get, set]
 Returns or sets the current source scope. More...
 
unsafe
NXOpen.Assemblies.RelinkerBuilder.LinkScope 
TargetScope [get, set]
 Returns or sets the current target scope. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Assemblies.RelinkerBuilder

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

Created in NX5.0.0

Member Enumeration Documentation

Represents the link category of Relinker, either geometry WAVE link or interpart expression.

Enumerator
WaveGeometry 

Indicate link category is wave geometry

InterpartExpression 

Indicate link category is interpart expression

Represents the relink option.

Per this option, relinker will search the corresponding source and do relinking.

Enumerator
InterpartExpression 

Indicate relink option is interpart expression only

WaveGeometry 

Indicate relink option is wave geometry only

Both 

Indicate relink option is both interpart expression and wave link

Represents the relink scope type of Relinker.

Relink Scope defines the link destination part files and source files. Relinker only searches part files defined in relink scope to get link/destination information and source parent for later reparenting

Enumerator
PartsInSession 

Indicate relink scope is parts in session

PartsInAssembly 

Indicate relink scope is parts in assembly

WorkPart 

Indicate relink scope is work part

SelectedParts 

Indicate relink scope is selected parts

Represents the link type option when browsing current available links.

As a filter, it tells Link Browser what links should be listed.

Enumerator
All 

Indicate relink browser type is all

NotBroken 

Indicate relink browser type is not broken only

Broken 

Indicate relink browser type is broken only

AutoLinked 

Indicate relink browser type is auto-linked only

WithMultipleSource 

Indicate relink browser type is with multuple source

Member Function Documentation

unsafe void NXOpen.Assemblies.RelinkerBuilder.ExecuteRelink ( )
inline

Relink with new source, for WAVE links, interpart explression or both.

Created in NX5.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

unsafe void NXOpen.Assemblies.RelinkerBuilder.ExportToInformationWindow ( )
inline

List all link information to the list window.

Created in NX5.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

unsafe int NXOpen.Assemblies.RelinkerBuilder.GetExpressionSourceCount ( NXOpen.Part  partID,
NXOpen.Expression  expID,
NXOpen.Expression  sourceID 
)
inline

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

Created in NX7.5.5

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters
partID
expID
sourceID
Returns
unsafe void NXOpen.Assemblies.RelinkerBuilder.RelinkInterpartExpression ( NXOpen.Part  partID,
NXOpen.Expression  expID,
NXOpen.Expression  sourceID 
)
inline

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

Created in NX7.5.5

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters
partID
expID
sourceID
unsafe void NXOpen.Assemblies.RelinkerBuilder.RelinkWaveFeature ( NXOpen.Part  partID,
NXOpen.Features.Feature  featID,
NXOpen.NXObject  sourceID 
)
inline

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

Created in NX7.5.5

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters
partID
featID
sourceID
unsafe void NXOpen.Assemblies.RelinkerBuilder.SearchWavelinksInterpartExpressions ( )
inline

Searches WAVE links and interpart expressions.

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

Created in NX10.0.3

License requirements: wave ("WAVE FUNCTIONALITY")

unsafe void NXOpen.Assemblies.RelinkerBuilder.UpdateSession ( )
inline

Updates the session.

Created in NX5.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

unsafe void NXOpen.Assemblies.RelinkerBuilder.UpdateSessionWithBreakDelayed ( )
inline

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

Created in NX8.5.1

License requirements: wave ("WAVE FUNCTIONALITY")

unsafe void NXOpen.Assemblies.RelinkerBuilder.ViewFeatureFailure ( )
inline

Views the feature failure information.

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

Created in NX5.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Property Documentation

unsafe bool NXOpen.Assemblies.RelinkerBuilder.BreakInterpartExpression
getset

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.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe bool NXOpen.Assemblies.RelinkerBuilder.BreakWaveLink
getset

Returns or sets the option to break WAVE links.

If it's true, relinker will break WAVE links after relinking. If it's false, relinker will not break WAVE links.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe bool NXOpen.Assemblies.RelinkerBuilder.FaceCurveDirectionAdjustment
getset

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.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe bool NXOpen.Assemblies.RelinkerBuilder.IncludeNonBrokenWaveLinks
getset

Returns or sets the option to include non-broken WAVE links or not.

If it's true, relinker will include non-broken WAVE links. If it's false, non-broken WAVE links will not be included while relinking. The default behavior in the relinker is not to include non-broken WAVE links.

Created in NX5.0.2

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe bool NXOpen.Assemblies.RelinkerBuilder.IncludeSuppressedComponents
getset

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.

Created in NX5.0.2

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe NXOpen.Assemblies.RelinkerBuilder.LinkCategory NXOpen.Assemblies.RelinkerBuilder.RelinkCategory
getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe NXOpen.Assemblies.RelinkerBuilder.LinkOption NXOpen.Assemblies.RelinkerBuilder.RelinkOption
getset

Returns or sets the link option.

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe NXOpen.Assemblies.RelinkerBuilder.LinkType NXOpen.Assemblies.RelinkerBuilder.RelinkType
getset

Returns or sets the current link type.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe bool NXOpen.Assemblies.RelinkerBuilder.SearchExistingInterPartExpressionOnly
getset

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

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe string NXOpen.Assemblies.RelinkerBuilder.SearchingDestinationObject
getset

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.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe string NXOpen.Assemblies.RelinkerBuilder.SearchingSourceObject
getset

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.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe string NXOpen.Assemblies.RelinkerBuilder.SearchingSourcePart
getset

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.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe string NXOpen.Assemblies.RelinkerBuilder.SearchingSourcePartAttribute
getset

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.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe NXOpen.Assemblies.SelectComponentList NXOpen.Assemblies.RelinkerBuilder.SelectComponent
get

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

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.Assemblies.SelectComponentList NXOpen.Assemblies.RelinkerBuilder.SelectComponentSource
get

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

Created in NX6.0.2

License requirements: None.

unsafe NXOpen.Assemblies.RelinkerBuilder.LinkScope NXOpen.Assemblies.RelinkerBuilder.SourceScope
getset

Returns or sets the current source scope.

Created in NX5.0.2

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")

unsafe NXOpen.Assemblies.RelinkerBuilder.LinkScope NXOpen.Assemblies.RelinkerBuilder.TargetScope
getset

Returns or sets the current target scope.

Created in NX5.0.2

License requirements to get this property: None.

License requirements to set this property: wave ("WAVE FUNCTIONALITY")


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