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:

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::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::SelectComponentList *	SelectComponent ()
	Returns a list of the selected component as relink target scope.

NXOpen::Assemblies::SelectComponentList *	SelectComponentSource ()
	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	SetRelinkType (NXOpen::Assemblies::RelinkerBuilder::LinkType linkType)
	Sets the current link type.

void	SetSearchingDestinationObject (const NXString &destinationObjectStr)
	Sets the searching destination object string.

void	SetSearchingDestinationObject (const char *destinationObjectStr)
	Sets the searching destination object string.

void	SetSearchingSourceObject (const NXString &sourceObjectStr)
	Sets the searching source object string.

void	SetSearchingSourceObject (const char *sourceObjectStr)
	Sets the searching source object string.

void	SetSearchingSourcePart (const NXString &sourcePartStr)
	Sets the searching source part string.

void	SetSearchingSourcePart (const char *sourcePartStr)
	Sets the searching source part string.

void	SetSearchingSourcePartAttribute (const NXString &sourcePartAttribute)
	Sets the searching source part attribute string.

void	SetSearchingSourcePartAttribute (const char *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 ()
	Updates the session.

void	UpdateSessionWithBreakDelayed ()
	Updates the session without immediately breaking wave links or inter part expressions.

void	ViewFeatureFailure ()
	Views the feature failure information.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::Assemblies::RelinkerBuilder::LinkCategory

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.

enum NXOpen::Assemblies::RelinkerBuilder::LinkOption

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.

enum NXOpen::Assemblies::RelinkerBuilder::LinkScope

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.

enum NXOpen::Assemblies::RelinkerBuilder::LinkType

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

bool NXOpen::Assemblies::RelinkerBuilder::BreakInterpartExpression ( )

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

bool NXOpen::Assemblies::RelinkerBuilder::BreakWaveLink ( )

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

void NXOpen::Assemblies::RelinkerBuilder::ExecuteRelink ( )

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

Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

void NXOpen::Assemblies::RelinkerBuilder::ExportToInformationWindow ( )

List all link information to the list window.

Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

bool NXOpen::Assemblies::RelinkerBuilder::FaceCurveDirectionAdjustment ( )

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

int NXOpen::Assemblies::RelinkerBuilder::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.

Returns: Created in NX7.5.5.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partID	partid
expID	expid
sourceID	sourceid

bool NXOpen::Assemblies::RelinkerBuilder::IncludeNonBrokenWaveLinks ( )

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

bool NXOpen::Assemblies::RelinkerBuilder::IncludeSuppressedComponents ( )

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

NXOpen::Assemblies::RelinkerBuilder::LinkCategory NXOpen::Assemblies::RelinkerBuilder::RelinkCategory ( )

Returns the relink category either wave geometry or interpart expression.

Created in NX5.0.0.

License requirements : None

void NXOpen::Assemblies::RelinkerBuilder::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.

Created in NX7.5.5.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partID	partid
expID	expid
sourceID	sourceid

NXOpen::Assemblies::RelinkerBuilder::LinkOption NXOpen::Assemblies::RelinkerBuilder::RelinkOption ( )

Returns the link option.

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

Created in NX5.0.0.

License requirements : None

NXOpen::Assemblies::RelinkerBuilder::LinkType NXOpen::Assemblies::RelinkerBuilder::RelinkType ( )

Returns the current link type.

Created in NX5.0.0.

License requirements : None

void NXOpen::Assemblies::RelinkerBuilder::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.

Created in NX7.5.5.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partID	partid
featID	featid
sourceID	sourceid

NXString NXOpen::Assemblies::RelinkerBuilder::SearchingDestinationObject ( )

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

NXString NXOpen::Assemblies::RelinkerBuilder::SearchingSourceObject ( )

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

NXString NXOpen::Assemblies::RelinkerBuilder::SearchingSourcePart ( )

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

NXString NXOpen::Assemblies::RelinkerBuilder::SearchingSourcePartAttribute ( )

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

NXOpen::Assemblies::SelectComponentList* NXOpen::Assemblies::RelinkerBuilder::SelectComponent ( )

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

Created in NX5.0.0.

License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Assemblies::RelinkerBuilder::SelectComponentSource ( )

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

Created in NX6.0.2.

License requirements : None

void NXOpen::Assemblies::RelinkerBuilder::SetBreakInterpartExpression ( bool breakInterPartExpression )

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

breakInterPartExpression breakinterpartexpression

void NXOpen::Assemblies::RelinkerBuilder::SetBreakWaveLink ( bool breakWave )

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

breakWave breakwave

void NXOpen::Assemblies::RelinkerBuilder::SetFaceCurveDirectionAdjustment ( bool adjustDir )

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

adjustDir adjustdir

void NXOpen::Assemblies::RelinkerBuilder::SetIncludeNonBrokenWaveLinks ( bool includeNonBrokenWaveLinks )

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

includeNonBrokenWaveLinks includenonbrokenwavelinks

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

includeSuppressedComponents includesuppressedcomponents

void NXOpen::Assemblies::RelinkerBuilder::SetRelinkCategory ( NXOpen::Assemblies::RelinkerBuilder::LinkCategory linkCategory )

Sets the relink category either wave geometry or interpart expression.

Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

linkCategory linkcategory

void NXOpen::Assemblies::RelinkerBuilder::SetRelinkOption ( NXOpen::Assemblies::RelinkerBuilder::LinkOption linkOption )

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

linkOption linkoption

void NXOpen::Assemblies::RelinkerBuilder::SetRelinkType ( NXOpen::Assemblies::RelinkerBuilder::LinkType linkType )

Sets the current link type.

Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

linkType linktype

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingDestinationObject ( const NXString & destinationObjectStr )

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

destinationObjectStr destinationobjectstr

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingDestinationObject ( const char * destinationObjectStr )

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

destinationObjectStr destinationobjectstr

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingSourceObject ( const NXString & sourceObjectStr )

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

sourceObjectStr sourceobjectstr

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingSourceObject ( const char * sourceObjectStr )

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

sourceObjectStr sourceobjectstr

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingSourcePart ( const NXString & sourcePartStr )

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

sourcePartStr sourcepartstr

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingSourcePart ( const char * sourcePartStr )

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

sourcePartStr sourcepartstr

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingSourcePartAttribute ( const NXString & sourcePartAttribute )

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

sourcePartAttribute sourcepartattribute

void NXOpen::Assemblies::RelinkerBuilder::SetSearchingSourcePartAttribute ( const char * sourcePartAttribute )

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

sourcePartAttribute sourcepartattribute

void NXOpen::Assemblies::RelinkerBuilder::SetSourceScope ( NXOpen::Assemblies::RelinkerBuilder::LinkScope sourceScope )

Sets the current source scope.

Created in NX5.0.2.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

sourceScope sourcescope

void NXOpen::Assemblies::RelinkerBuilder::SetTargetScope ( NXOpen::Assemblies::RelinkerBuilder::LinkScope targetScope )

Sets the current target scope.

Created in NX5.0.2.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

targetScope targetscope

NXOpen::Assemblies::RelinkerBuilder::LinkScope NXOpen::Assemblies::RelinkerBuilder::SourceScope ( )

Returns the current source scope.

Created in NX5.0.2.

License requirements : None

NXOpen::Assemblies::RelinkerBuilder::LinkScope NXOpen::Assemblies::RelinkerBuilder::TargetScope ( )

Returns the current target scope.

Created in NX5.0.2.

License requirements : None

void NXOpen::Assemblies::RelinkerBuilder::UpdateSession ( )

Updates the session.

Created in NX5.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

void NXOpen::Assemblies::RelinkerBuilder::UpdateSessionWithBreakDelayed ( )

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

Created in NX8.5.1.

License requirements : wave ("WAVE FUNCTIONALITY")

void NXOpen::Assemblies::RelinkerBuilder::ViewFeatureFailure ( )

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

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

Assemblies_RelinkerBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation