Represents a NXOpen.Assemblies.ReplaceComponentBuilder builder. More...

Inheritance diagram for NXOpen.Assemblies.ReplaceComponentBuilder:

Public Types
enum	ComponentLayerOption { Maintain, Original, Work, AsSpecified }
	Represents possible layer option for replacement part More...

enum	ComponentNameOption { Maintain, Original, AsSpecified }
	Represents possible component name option for replace operation More...

enum	ComponentReferenceSet { Maintain, EntirePart, Empty, Others }
	Represents possible reference set for replacement part More...

Public Member Functions
unsafe NXOpen.Assemblies.ReplaceComponentBuilder.ComponentReferenceSet	GetComponentReferenceSetType (out string referenceSetName)
	Get the reference set More...

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

unsafe NXOpen.PartLoadStatus	RegisterReplacePartLoadStatus ()
	Register the part load status with the replace operation. More...

unsafe void	SetComponentReferenceSetType (NXOpen.Assemblies.ReplaceComponentBuilder.ComponentReferenceSet componentReferenceSet, string referenceSetName)
	Set the reference set 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	AllowTemporaryPartsToReplace `[get, set]`
	Returns or sets the flag to determine whether unsaved parts are allowed to replace. More...

unsafe int	ComponentLayer `[get, set]`
	Returns or sets the layer for the new replacement part. More...

unsafe NXOpen.Assemblies.ReplaceComponentBuilder.ComponentLayerOption	ComponentLayerOptionType `[get, set]`
	Returns or sets the layer options More...

unsafe string	ComponentName `[get, set]`
	Returns or sets the component name More...

unsafe NXOpen.Assemblies.ReplaceComponentBuilder.ComponentNameOption	ComponentNameType `[get, set]`
	Returns or sets the component name options More...

unsafe NXOpen.SelectDisplayableObjectList	ComponentsToReplace `[get]`
	Returns the objects to be replaced. More...

unsafe bool	MaintainRelationships `[get, set]`
	Returns or sets the maintain relationships More...

unsafe bool	ReplaceAllOccurrences `[get, set]`
	Returns or sets the replace all occurrences More...

unsafe string	ReplacementPart `[get, set]`
	Returns or sets the replacement part. 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.ReplaceComponentBuilder builder.

Input to this class can be PSM facet objects.

To create a new instance of this class, use NXOpen.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

enum NXOpen.Assemblies.ReplaceComponentBuilder.ComponentLayerOption

Represents possible layer option for replacement part

Enumerator
Maintain	Maintain the layer of the component being replaced out
Original	Set the layer to replacement part's original layer
Work	Set the layer to current work layer
AsSpecified	Set the specified layer

enum NXOpen.Assemblies.ReplaceComponentBuilder.ComponentNameOption

Represents possible component name option for replace operation

Enumerator
Maintain	Maintain the component name of the component being replaced out
Original	Use the replacement part name as the component name
AsSpecified	Set the specified component name

enum NXOpen.Assemblies.ReplaceComponentBuilder.ComponentReferenceSet

Represents possible reference set for replacement part

Enumerator
Maintain	Maintain the reference set of the component being replaced out
EntirePart	Set the reference set to Entire Part
Empty	Set the reference to Empty
Others	Set the specified reference set

Member Function Documentation

unsafe NXOpen.Assemblies.ReplaceComponentBuilder.ComponentReferenceSet NXOpen.Assemblies.ReplaceComponentBuilder.GetComponentReferenceSetType ( out string referenceSetName )

inline

Get the reference set

Created in NX6.0.0

License requirements: None.

Returns

Parameters

referenceSetName Name of the reference set

unsafe NXOpen.ErrorList NXOpen.Assemblies.ReplaceComponentBuilder.GetErrorList ( )

inline

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

Caller need to dispose the error list after processing it.

Created in NX8.0.2

License requirements: None.

Returns

unsafe NXOpen.PartLoadStatus NXOpen.Assemblies.ReplaceComponentBuilder.RegisterReplacePartLoadStatus ( )

inline

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.

Created in NX6.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns

unsafe void NXOpen.Assemblies.ReplaceComponentBuilder.SetComponentReferenceSetType	(	NXOpen.Assemblies.ReplaceComponentBuilder.ComponentReferenceSet	componentReferenceSet,
		string	referenceSetName
	)

inline

Set the reference set

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

componentReferenceSet	Reference set
referenceSetName	Name of the reference set. Used only when componentReferenceSet is NXOpen.Assemblies.ReplaceComponentBuilder.ComponentReferenceSet.Others

Property Documentation

unsafe bool NXOpen.Assemblies.ReplaceComponentBuilder.AllowTemporaryPartsToReplace

getset

Returns or 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 to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe int NXOpen.Assemblies.ReplaceComponentBuilder.ComponentLayer

getset

Returns or sets the layer for the new replacement part.

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

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Assemblies.ReplaceComponentBuilder.ComponentLayerOption NXOpen.Assemblies.ReplaceComponentBuilder.ComponentLayerOptionType

getset

Returns or sets the layer options

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe string NXOpen.Assemblies.ReplaceComponentBuilder.ComponentName

getset

Returns or sets the component name

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Assemblies.ReplaceComponentBuilder.ComponentNameOption NXOpen.Assemblies.ReplaceComponentBuilder.ComponentNameType

getset

Returns or sets the component name options

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.SelectDisplayableObjectList NXOpen.Assemblies.ReplaceComponentBuilder.ComponentsToReplace

get

Returns the objects to be replaced.

Created in NX6.0.0

License requirements: None.

unsafe bool NXOpen.Assemblies.ReplaceComponentBuilder.MaintainRelationships

getset

Returns or sets the maintain relationships

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.Assemblies.ReplaceComponentBuilder.ReplaceAllOccurrences

getset

Returns or sets the replace all occurrences

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe string NXOpen.Assemblies.ReplaceComponentBuilder.ReplacementPart

getset

Returns or sets the replacement part.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

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

Assemblies_ReplaceComponentBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation