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

Represents a Assemblies::ReplaceComponentBuilder builder
To create a new instance of this class, use Assemblies::AssemblyManager::CreateReplaceComponentBuilder
Default values. More...

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

List of all members.

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::SelectDisplayableObjectListComponentsToReplace ()
 Returns the objects to be replaced.
NXOpen::Assemblies::ReplaceComponentBuilder::ComponentReferenceSet GetComponentReferenceSetType (NXString *referenceSetName)
 Get the reference set.
bool MaintainRelationships ()
 Returns the maintain relationships
Created in NX6.0.0.
NXOpen::PartLoadStatusRegisterReplacePartLoadStatus ()
 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 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 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.

Detailed Description

Represents a Assemblies::ReplaceComponentBuilder builder
To create a new instance of this class, use Assemblies::AssemblyManager::CreateReplaceComponentBuilder
Default values.

Property Value

ComponentLayer

1

ComponentLayerOptionType

Maintain

ComponentName

ComponentNameType

AsSpecified

MaintainRelationships

1

ReplaceAllOccurrences

0


Created in NX6.0.0.


Member Enumeration Documentation

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.

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.

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

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

Returns the layer for the new replacement part.

  1. -1 means use the original layers defined in the component.
  2. 0 means use the work layer.
  3. 1-256 means use the specified layer.


Created in NX6.0.0.

License requirements : None

Returns the layer options
Created in NX6.0.0.



License requirements : None

Returns the component name
Created in NX6.0.0.



License requirements : None

Returns the component name options
Created in NX7.5.0.



License requirements : None

Returns the objects to be replaced.


Created in NX6.0.0.

License requirements : None

Get the reference set.

Returns:

Created in NX6.0.0.

License requirements : None
Parameters:
referenceSetNameName of the reference set

Returns the maintain relationships
Created in NX6.0.0.



License requirements : None

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

Returns the replace all occurrences
Created in NX6.0.0.



License requirements : None

Returns the replacement part.


Created in NX6.0.0.

License requirements : None

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

Sets the layer for the new replacement part.

  1. -1 means use the original layers defined in the component.
  2. 0 means use the work layer.
  3. 1-256 means use the specified layer.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
componentLayercomponentlayer

Sets the layer options
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
componentLayerOptioncomponentlayeroption

Sets the component name
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
componentNamecomponentname

Sets the component name options
Created in NX7.5.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
componentNameOptioncomponentnameoption

Set the reference set
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
componentReferenceSetReference set
referenceSetNameName of the reference set. Used only when componentReferenceSet is Assemblies::ReplaceComponentBuilder::ComponentReferenceSetOthers
NOTE: The full Unicode character set is not supported for this parameter.

Sets the maintain relationships
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
maintainRelationshipsmaintainrelationships

Sets the replace all occurrences
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
replaceAllOccurrencesreplacealloccurrences

Sets the replacement part.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
replacementPartreplacementpart

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