NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Assemblies::RelinkerBuilder Class Reference

Represents a Assemblies::RelinkerBuilder
To create a new instance of this class, use Assemblies::RelinkerCollection::CreateBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::Assemblies::RelinkerBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  LinkCategory { LinkCategoryWaveGeometry, LinkCategoryInterpartExpression }
 Represents the link category of Relinker, either geometry WAVE link or interpart expression. More...
enum  LinkOption { LinkOptionInterpartExpression, LinkOptionWaveGeometry, LinkOptionBoth }
 Represents the relink option. More...
enum  LinkScope { LinkScopePartsInSession, LinkScopePartsInAssembly, LinkScopeWorkPart, LinkScopeSelectedParts }
 Represents the relink scope type of Relinker. More...
enum  LinkType {
  LinkTypeAll, LinkTypeNotBroken, LinkTypeBroken, LinkTypeAutoLinked,
  LinkTypeWithMultipleSource
}
 Represents the link type option when browsing current available links. More...

Public Member Functions

bool BreakInterpartExpression ()
 Returns the option to break interpart expression.
bool BreakWaveLink ()
 Returns the option to break WAVE links.
void ExecuteRelink ()
 Relink with new source, for WAVE links, interpart explression or both.
void ExportToInformationWindow ()
 List all link information to the list window.
bool FaceCurveDirectionAdjustment ()
 Returns the option to adjust face or curve direction.
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.
bool IncludeNonBrokenWaveLinks ()
 Returns the option to include non-broken WAVE links or not.
bool IncludeSuppressedComponents ()
 Returns the option to include suppressed components as source candidates or not.
NXOpen::Assemblies::RelinkerBuilder::LinkCategory RelinkCategory ()
 Returns the relink category either wave geometry or interpart expression.
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.
NXOpen::Assemblies::RelinkerBuilder::LinkOption RelinkOption ()
 Returns the link option.
NXOpen::Assemblies::RelinkerBuilder::LinkScope RelinkScope ()
 Returns the current relink scope.
NXOpen::Assemblies::RelinkerBuilder::LinkType RelinkType ()
 Returns the current link type.
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.
NXString SearchingDestinationObject ()
 Returns the searching destination object string.
NXString SearchingSourceObject ()
 Returns the searching source object string.
NXString SearchingSourcePart ()
 Returns the searching source part string.
NXString SearchingSourcePartAttribute ()
 Returns the searching source part attribute string.
NXOpen::Assemblies::SelectComponentListSelectComponent ()
 Returns a list of the selected component as relink target scope.
NXOpen::Assemblies::SelectComponentListSelectComponentSource ()
 Returns a list of the selected component as relink source scope.
void SetBreakInterpartExpression (bool breakInterPartExpression)
 Sets the option to break interpart expression.
void SetBreakWaveLink (bool breakWave)
 Sets the option to break WAVE links.
void SetFaceCurveDirectionAdjustment (bool adjustDir)
 Sets the option to adjust face or curve direction.
void SetIncludeNonBrokenWaveLinks (bool includeNonBrokenWaveLinks)
 Sets the option to include non-broken WAVE links or not.
void SetIncludeSuppressedComponents (bool includeSuppressedComponents)
 Sets the option to include suppressed components as source candidates or not.
void SetRelinkCategory (NXOpen::Assemblies::RelinkerBuilder::LinkCategory linkCategory)
 Sets the relink category either wave geometry or interpart expression.
void SetRelinkOption (NXOpen::Assemblies::RelinkerBuilder::LinkOption linkOption)
 Sets the link option.
void SetRelinkScope (NXOpen::Assemblies::RelinkerBuilder::LinkScope relinkScope)
 Sets the current relink scope.
void SetRelinkType (NXOpen::Assemblies::RelinkerBuilder::LinkType linkType)
 Sets the current link type.
void SetSearchingDestinationObject (const NXString &destinationObjectStr)
 Sets the searching destination object string.
void SetSearchingSourceObject (const NXString &sourceObjectStr)
 Sets the searching source object string.
void SetSearchingSourcePart (const NXString &sourcePartStr)
 Sets the searching source part string.
void SetSearchingSourcePartAttribute (const NXString &sourcePartAttribute)
 Sets the searching source part attribute string.
void SetSourceScope (NXOpen::Assemblies::RelinkerBuilder::LinkScope sourceScope)
 Sets the current source scope.
void SetTargetScope (NXOpen::Assemblies::RelinkerBuilder::LinkScope targetScope)
 Sets the current target scope.
NXOpen::Assemblies::RelinkerBuilder::LinkScope SourceScope ()
 Returns the current source scope.
NXOpen::Assemblies::RelinkerBuilder::LinkScope TargetScope ()
 Returns the current target scope.
void UpdateSession ()
 Update session.
void ViewFeatureFailure ()
 View the feature failure information.

Detailed Description

Represents a Assemblies::RelinkerBuilder
To create a new instance of this class, use 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:
LinkCategoryWaveGeometry 

Indicate link category is wave geometry.

LinkCategoryInterpartExpression 

Indicate link category is interpart expression.

Represents the relink option.

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

Enumerator:
LinkOptionInterpartExpression 

Indicate relink option is interpart expression only.

LinkOptionWaveGeometry 

Indicate relink option is wave geometry only.

LinkOptionBoth 

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:
LinkScopePartsInSession 

Indicate relink scope is parts in session.

LinkScopePartsInAssembly 

Indicate relink scope is parts in assembly.

LinkScopeWorkPart 

Indicate relink scope is work part.

LinkScopeSelectedParts 

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:
LinkTypeAll 

Indicate relink browser type is all.

LinkTypeNotBroken 

Indicate relink browser type is not broken only.

LinkTypeBroken 

Indicate relink browser type is broken only.

LinkTypeAutoLinked 

Indicate relink browser type is auto-linked only.

LinkTypeWithMultipleSource 

Indicate relink browser type is with multuple source.


Member Function Documentation

Returns 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 : None

Returns 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 : None

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


Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

List all link information to the list window.


Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Returns 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 : None

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

Returns:

Created in NX7.5.5.

License requirements : wave ("WAVE FUNCTIONALITY")
Parameters:
partIDpartid
expIDexpid
sourceIDsourceid

Returns 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 : None

Returns 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 : None

Returns the relink category either wave geometry or interpart expression.


Created in NX5.0.0.

License requirements : None

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:
partIDpartid
expIDexpid
sourceIDsourceid

Returns the link option.

Relinker will check this option to relink WAVE, interpart expression or both
Created in NX5.0.0.

License requirements : None

Returns the current relink scope.

This one is deprecated, use TargetScope instead.

Deprecated:
Deprecated in NX5.0.2.


Created in NX5.0.0.

License requirements : None

Returns the current link type.


Created in NX5.0.0.

License requirements : None

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:
partIDpartid
featIDfeatid
sourceIDsourceid

Returns 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 : None

Returns 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 : None

Returns 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 : None

Returns 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 : None

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


Created in NX5.0.0.

License requirements : None

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


Created in NX6.0.2.

License requirements : None

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
breakInterPartExpressionbreakinterpartexpression

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
breakWavebreakwave

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
adjustDiradjustdir

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
includeNonBrokenWaveLinksincludenonbrokenwavelinks
void NXOpen::Assemblies::RelinkerBuilder::SetIncludeSuppressedComponents ( bool  includeSuppressedComponents)

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
includeSuppressedComponentsincludesuppressedcomponents

Sets the relink category either wave geometry or interpart expression.


Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters:
linkCategorylinkcategory

Sets the link option.

Relinker will check this option to relink WAVE, interpart expression or both
Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters:
linkOptionlinkoption

Sets the current relink scope.

This one is deprecated, use TargetScope instead.

Deprecated:
Deprecated in NX5.0.2.


Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters:
relinkScoperelinkscope

Sets the current link type.


Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters:
linkTypelinktype

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
destinationObjectStrdestinationobjectstr

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
sourceObjectStrsourceobjectstr

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
sourcePartStrsourcepartstr

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 : wave ("WAVE FUNCTIONALITY")

Parameters:
sourcePartAttributesourcepartattribute

Sets the current source scope.


Created in NX5.0.2.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters:
sourceScopesourcescope

Sets the current target scope.


Created in NX5.0.2.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters:
targetScopetargetscope

Returns the current source scope.


Created in NX5.0.2.

License requirements : None

Returns the current target scope.


Created in NX5.0.2.

License requirements : None

Update session.


Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

View 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")


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