CopyDesignElementBuilder Class

class NXOpen.Assemblies.CopyDesignElementBuilder

Bases: NXOpen.Builder, NXOpen.IAttributeSourceObjectBuilder

Represents a builder class that performs copying design element operation in 4GD.

To create a new instance of this class, use NXOpen.CollaborativeContentManager.CreateCopyDesignElementBuilder()

New in version NX12.0.0.

Properties

Property Description
DesignElementsToCopy Returns the design elements to copy
Tag Returns the Tag for this object.

Methods

Method Description
AutoAssignAttributes Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.
AutoAssignAttributesWithNamingPattern Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.
Commit Commits any edits that have been applied to the builder.
CreateAttributeTitleToNamingPatternMap Creates a map object of attribute titles to their corresponding naming pattern
CreateDesignElementLogicalObjects Creates the pre-creation objects for the design elements to be copied
DeleteCopiedComponents Removes the copied components created during the copy operation
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetLogicalObjects Returns the pre-creation objects
GetLogicalObjectsHavingUnassignedRequiredAttributes Returns the pre-creation objects which have unassign required attributes
GetObject Returns the object currently being edited by this builder.
GetOperationFailures Returns the design element copy operation failures
PartiallyCommit Copy design elements with minimal required information.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

DesignElementsToCopy

CopyDesignElementBuilder.DesignElementsToCopy

Returns the design elements to copy

-------------------------------------

Getter Method

Signature DesignElementsToCopy

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX12.0.0.

License requirements: None.

Method Detail

AutoAssignAttributes

CopyDesignElementBuilder.AutoAssignAttributes

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Signature AutoAssignAttributes(objects)

Parameters:objects (list of NXOpen.NXObject) –
Returns:
Return type:NXOpen.ErrorList

New in version NX8.5.0.

License requirements: None.

AutoAssignAttributesWithNamingPattern

CopyDesignElementBuilder.AutoAssignAttributesWithNamingPattern

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap()

Signature AutoAssignAttributesWithNamingPattern(objects, properties)

Parameters:
Returns:
Return type:

NXOpen.ErrorList

New in version NX12.0.0.

License requirements: None.

CreateAttributeTitleToNamingPatternMap

CopyDesignElementBuilder.CreateAttributeTitleToNamingPatternMap

Creates a map object of attribute titles to their corresponding naming pattern

Signature CreateAttributeTitleToNamingPatternMap(attributeTitles, titlePatterns)

Parameters:
  • attributeTitles (list of str) –
  • titlePatterns (list of str) –
Returns:
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: None.

CreateDesignElementLogicalObjects

CopyDesignElementBuilder.CreateDesignElementLogicalObjects

Creates the pre-creation objects for the design elements to be copied

Signature CreateDesignElementLogicalObjects()

Returns:
Return type:list of NXOpen.PDM.LogicalObject

New in version NX12.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

DeleteCopiedComponents

CopyDesignElementBuilder.DeleteCopiedComponents

Removes the copied components created during the copy operation

Signature DeleteCopiedComponents()

New in version NX12.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

GetLogicalObjects

CopyDesignElementBuilder.GetLogicalObjects

Returns the pre-creation objects

Signature GetLogicalObjects()

Returns:
Return type:list of NXOpen.PDM.LogicalObject

New in version NX12.0.0.

License requirements: None.

GetLogicalObjectsHavingUnassignedRequiredAttributes

CopyDesignElementBuilder.GetLogicalObjectsHavingUnassignedRequiredAttributes

Returns the pre-creation objects which have unassign required attributes

Signature GetLogicalObjectsHavingUnassignedRequiredAttributes()

Returns:
Return type:list of NXOpen.PDM.LogicalObject

New in version NX12.0.0.

License requirements: None.

GetOperationFailures

CopyDesignElementBuilder.GetOperationFailures

Returns the design element copy operation failures

Signature GetOperationFailures()

Returns:
Return type:NXOpen.ErrorList

New in version NX12.0.0.

License requirements: None.

PartiallyCommit

CopyDesignElementBuilder.PartiallyCommit

Copy design elements with minimal required information.

Call to builder Commit is required after this to Commit creation.

Signature PartiallyCommit()

New in version NX12.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Validate

CopyDesignElementBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.