Represents a @link Assemblies::ReplaceComponentBuilder Assemblies::ReplaceComponentBuilder@endlink  builder  <br> To create a new instance of this class, use @link Assemblies::AssemblyManager::CreateReplaceComponentBuilder  Assemblies::AssemblyManager::CreateReplaceComponentBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::Assemblies::ReplaceComponentBuilder:

Public Types
enum	ComponentLayerOption { ComponentLayerOptionMaintain, ComponentLayerOptionOriginal, ComponentLayerOptionWork, ComponentLayerOptionAsSpecified }
	Represents possible layer option for replacement part. More...

enum	ComponentNameOption { ComponentNameOptionMaintain, ComponentNameOptionOriginal, ComponentNameOptionAsSpecified }
	Represents possible component name option for replace operation. More...

enum	ComponentReferenceSet { ComponentReferenceSetMaintain, ComponentReferenceSetEntirePart, ComponentReferenceSetEmpty, ComponentReferenceSetOthers }
	Represents possible reference set for replacement part. More...

Public Member Functions
bool	AllowTemporaryPartsToReplace ()
	Returns the flag to determine whether unsaved parts are allowed to replace.

int	ComponentLayer ()
	Returns the layer for the new replacement part.

NXOpen::Assemblies::ReplaceComponentBuilder::ComponentLayerOption	ComponentLayerOptionType ()
	Returns the layer options Created in NX6.0.0.

NXString	ComponentName ()
	Returns the component name Created in NX6.0.0.

NXOpen::Assemblies::ReplaceComponentBuilder::ComponentNameOption	ComponentNameType ()
	Returns the component name options Created in NX7.5.0.

NXOpen::SelectDisplayableObjectList *	ComponentsToReplace ()
	Returns the objects to be replaced.

NXOpen::Assemblies::ReplaceComponentBuilder::ComponentReferenceSet	GetComponentReferenceSetType (NXString *referenceSetName)
	Get the reference set.

NXOpen::ErrorList *	GetErrorList ()
	Get the list of components that failed to replace with their corresponding error codes.

bool	MaintainRelationships ()
	Returns the maintain relationships Created in NX6.0.0.

NXOpen::PartLoadStatus *	RegisterReplacePartLoadStatus ()
	Register the part load status with the replace operation.

bool	ReplaceAllOccurrences ()
	Returns the replace all occurrences Created in NX6.0.0.

NXString	ReplacementPart ()
	Returns the replacement part.

void	SetAllowTemporaryPartsToReplace (bool allowTemporaryPartsToReplace)
	Sets the flag to determine whether unsaved parts are allowed to replace.

void	SetComponentLayer (int componentLayer)
	Sets the layer for the new replacement part.

void	SetComponentLayerOptionType (NXOpen::Assemblies::ReplaceComponentBuilder::ComponentLayerOption componentLayerOption)
	Sets the layer options Created in NX6.0.0.

void	SetComponentName (const NXString &componentName)
	Sets the component name Created in NX6.0.0.

void	SetComponentName (const char *componentName)
	Sets the component name Created in NX6.0.0.

void	SetComponentNameType (NXOpen::Assemblies::ReplaceComponentBuilder::ComponentNameOption componentNameOption)
	Sets the component name options Created in NX7.5.0.

void	SetComponentReferenceSetType (NXOpen::Assemblies::ReplaceComponentBuilder::ComponentReferenceSet componentReferenceSet, const NXString &referenceSetName)
	Set the reference set Created in NX6.0.0.

void	SetComponentReferenceSetType (NXOpen::Assemblies::ReplaceComponentBuilder::ComponentReferenceSet componentReferenceSet, const char *referenceSetName)
	Set the reference set Created in NX6.0.0.

void	SetMaintainRelationships (bool maintainRelationships)
	Sets the maintain relationships Created in NX6.0.0.

void	SetReplaceAllOccurrences (bool replaceAllOccurrences)
	Sets the replace all occurrences Created in NX6.0.0.

void	SetReplacementPart (const NXString &replacementPart)
	Sets the replacement part.

void	SetReplacementPart (const char *replacementPart)
	Sets the replacement part.

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 @link Assemblies::ReplaceComponentBuilder Assemblies::ReplaceComponentBuilder@endlink  builder  <br> To create a new instance of this class, use @link Assemblies::AssemblyManager::CreateReplaceComponentBuilder  Assemblies::AssemblyManager::CreateReplaceComponentBuilder @endlink  <br>

Default values.

Property

Value

ComponentLayer

1

ComponentLayerOptionType

Maintain

ComponentName

ComponentNameType

AsSpecified

MaintainRelationships

1

ReplaceAllOccurrences

0

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Assemblies::ReplaceComponentBuilder::ComponentLayerOption

Represents possible layer option for replacement part.

Enumerator:

ComponentLayerOptionMaintain	Maintain the layer of the component being replaced out.
ComponentLayerOptionOriginal	Set the layer to replacement part's original layer.
ComponentLayerOptionWork	Set the layer to current work layer.
ComponentLayerOptionAsSpecified	Set the specified layer.

enum NXOpen::Assemblies::ReplaceComponentBuilder::ComponentNameOption

Represents possible component name option for replace operation.

Enumerator:

ComponentNameOptionMaintain	Maintain the component name of the component being replaced out.
ComponentNameOptionOriginal	Use the replacement part name as the component name.
ComponentNameOptionAsSpecified	Set the specified component name.

enum NXOpen::Assemblies::ReplaceComponentBuilder::ComponentReferenceSet

Represents possible reference set for replacement part.

Enumerator:

ComponentReferenceSetMaintain	Maintain the reference set of the component being replaced out.
ComponentReferenceSetEntirePart	Set the reference set to Entire Part.
ComponentReferenceSetEmpty	Set the reference to Empty.
ComponentReferenceSetOthers	Set the specified reference set.

Member Function Documentation

bool NXOpen::Assemblies::ReplaceComponentBuilder::AllowTemporaryPartsToReplace ( )

Returns the flag to determine whether unsaved parts are allowed to replace.

If set to true, then this may result in loss of unsaved data.
Created in NX7.5.1.

License requirements : None

int NXOpen::Assemblies::ReplaceComponentBuilder::ComponentLayer ( )

Returns the layer for the new replacement part.

       <ol>
       <li>-1 means use the original layers defined in the component.</li>
       <li>0 means use the work layer.</li>
       <li>1-256 means use the specified layer.</li>
      </ol>

Created in NX6.0.0.

License requirements : None

NXOpen::Assemblies::ReplaceComponentBuilder::ComponentLayerOption NXOpen::Assemblies::ReplaceComponentBuilder::ComponentLayerOptionType ( )

Returns the layer options
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Assemblies::ReplaceComponentBuilder::ComponentName ( )

Returns the component name
Created in NX6.0.0.

License requirements : None

NXOpen::Assemblies::ReplaceComponentBuilder::ComponentNameOption NXOpen::Assemblies::ReplaceComponentBuilder::ComponentNameType ( )

Returns the component name options
Created in NX7.5.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::ReplaceComponentBuilder::ComponentsToReplace ( )

Returns the objects to be replaced.

Created in NX6.0.0.

License requirements : None

NXOpen::Assemblies::ReplaceComponentBuilder::ComponentReferenceSet NXOpen::Assemblies::ReplaceComponentBuilder::GetComponentReferenceSetType ( NXString * referenceSetName )

Get the reference set.

Returns: Created in NX6.0.0.

License requirements : None

Parameters

referenceSetName Name of the reference set

NXOpen::ErrorList* NXOpen::Assemblies::ReplaceComponentBuilder::GetErrorList ( )

Get the list of components that failed to replace with their corresponding error codes.

Caller need to dispose the error list after processing it.

Returns: Created in NX8.0.2.

License requirements : None

bool NXOpen::Assemblies::ReplaceComponentBuilder::MaintainRelationships ( )

Returns the maintain relationships
Created in NX6.0.0.

License requirements : None

NXOpen::PartLoadStatus* NXOpen::Assemblies::ReplaceComponentBuilder::RegisterReplacePartLoadStatus ( )

Register the part load status with the replace operation.

If during the operation a part could not be loaded, then this object will be used to store error information.

Returns: Created in NX6.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

bool NXOpen::Assemblies::ReplaceComponentBuilder::ReplaceAllOccurrences ( )

Returns the replace all occurrences
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Assemblies::ReplaceComponentBuilder::ReplacementPart ( )

Returns the replacement part.

Created in NX6.0.0.

License requirements : None

void NXOpen::Assemblies::ReplaceComponentBuilder::SetAllowTemporaryPartsToReplace ( bool allowTemporaryPartsToReplace )

Sets the flag to determine whether unsaved parts are allowed to replace.

If set to true, then this may result in loss of unsaved data.
Created in NX7.5.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

allowTemporaryPartsToReplace allowtemporarypartstoreplace

void NXOpen::Assemblies::ReplaceComponentBuilder::SetComponentLayer ( int componentLayer )

Sets the layer for the new replacement part.

       <ol>
       <li>-1 means use the original layers defined in the component.</li>
       <li>0 means use the work layer.</li>
       <li>1-256 means use the specified layer.</li>
      </ol>

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

componentLayer componentlayer

void NXOpen::Assemblies::ReplaceComponentBuilder::SetComponentLayerOptionType ( NXOpen::Assemblies::ReplaceComponentBuilder::ComponentLayerOption componentLayerOption )

Sets the layer options
Created in NX6.0.0.