CopyPasteNewBuilder Class

class NXOpen.Features.ShipDesign.CopyPasteNewBuilder

Bases: NXOpen.Features.FeatureBuilder, NXOpen.IAttributeSourceObjectBuilder

Represents a NXOpen.Features.ShipDesign.CopyPasteNewBuilder It is used in Ship Building Application.

The operation copies one or more components and pastes them as new parts while re-parenting and maintaining WAVE links

To create a new instance of this class, use NXOpen.Features.ShipCollection.CreateCopyPasteNewBuilder()

Default values.

Property Value
AngularTolerance 5
CopySection false

New in version NX8.0.0.

Properties

Property Description
AlgorithmVersion Returns or sets the value of algorithm version is used to define the version information.
AngularTolerance Returns or sets the value of angular tolerance is used to define the angular difference from qualified candidate face / plane normal to source face / plane normal.
ComponentsToCopy Returns the components to copy
CopyApproachOption Returns or sets an option to determine the approach to copy the ship standard parts between planes.
CopySection Returns or sets the flag is used to define if linear tolerance on UI would be used when matching geometry.
LinearTolerance Returns or sets the value of linear tolerance is used to define the tolerance between candidate object and transformed source object.
ParentFeatureInternal Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag Returns or sets the patch solution flag
PatchSurfaceFilename Returns or sets the patch surface filename
SelectionFrom Returns the From geometry
SelectionTo Returns the To geometry
ShipNames Returns the Ship Names builder, used to assign names to the copied objects created.
ShowXmlReport Returns or sets the flag to indicate whether or not to show the xml report on copy paste results
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
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.
CommitFeature Commits the feature parameters and creates the feature
CreateAttributeTitleToNamingPatternMap Creates a map object of attribute titles to their corresponding naming pattern
CreateLogicalObjects Creates the pre-creation logical objects
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.
GetFeature Returns the feature currently being edited by this builder.
GetObject Returns the object currently being edited by this builder.
GetOperationFailures Gets the operation failure error list object
HideInternalParentFeatureAfterEdit Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal Set the internal parent feature of the feature being edited to external
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

CopyPasteNewBuilderCopyApproach Enumeration Represents the approach of copying ship standard parts.
CopyPasteNewBuilderVersionID Enumeration add version identifiers for the different revisions of the copy paste new feature.

Property Detail

AlgorithmVersion

CopyPasteNewBuilder.AlgorithmVersion

Returns or sets the value of algorithm version is used to define the version information.

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

Getter Method

Signature AlgorithmVersion

Returns:
Return type:NXOpen.Features.ShipDesign.CopyPasteNewBuilderVersionID

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature AlgorithmVersion

Parameters:algorithmVersion (NXOpen.Features.ShipDesign.CopyPasteNewBuilderVersionID) –

New in version NX12.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

AngularTolerance

CopyPasteNewBuilder.AngularTolerance

Returns or sets the value of angular tolerance is used to define the angular difference from qualified candidate face / plane normal to source face / plane normal.

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

Getter Method

Signature AngularTolerance

Returns:
Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature AngularTolerance

Parameters:tolerance (float) –

New in version NX11.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

ComponentsToCopy

CopyPasteNewBuilder.ComponentsToCopy

Returns the components to copy

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

Getter Method

Signature ComponentsToCopy

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

CopyApproachOption

CopyPasteNewBuilder.CopyApproachOption

Returns or sets an option to determine the approach to copy the ship standard parts between planes.

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

Getter Method

Signature CopyApproachOption

Returns:
Return type:NXOpen.Features.ShipDesign.CopyPasteNewBuilderCopyApproach

New in version NX11.0.2.

License requirements: None.

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

Setter Method

Signature CopyApproachOption

Parameters:copyApproachOption (NXOpen.Features.ShipDesign.CopyPasteNewBuilderCopyApproach) –

New in version NX11.0.2.

License requirements: nx_ship_detail (“Ship Detail Design”)

CopySection

CopyPasteNewBuilder.CopySection

Returns or sets the flag is used to define if linear tolerance on UI would be used when matching geometry.

If false, the linear tolerance will be set with max double value as default.

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

Getter Method

Signature CopySection

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature CopySection

Parameters:copySection (bool) –

New in version NX11.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

LinearTolerance

CopyPasteNewBuilder.LinearTolerance

Returns or sets the value of linear tolerance is used to define the tolerance between candidate object and transformed source object.

For example, the distance from the qualified candidate curve to the transformed sample points of source curve shoud be within linear tolerance. And for body, it checks the distance from the qualified body’s faces and the transformed sample points of source body’s corresponding faces.

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

Getter Method

Signature LinearTolerance

Returns:
Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature LinearTolerance

Parameters:tolerance (float) –

New in version NX11.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

SelectionFrom

CopyPasteNewBuilder.SelectionFrom

Returns the From geometry

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

Getter Method

Signature SelectionFrom

Returns:
Return type:NXOpen.SelectNXObject

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

SelectionTo

CopyPasteNewBuilder.SelectionTo

Returns the To geometry

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

Getter Method

Signature SelectionTo

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

ShipNames

CopyPasteNewBuilder.ShipNames

Returns the Ship Names builder, used to assign names to the copied objects created.

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

Getter Method

Signature ShipNames

Returns:Ship Names List Builder
Return type:NXOpen.Features.ShipDesign.ShipNamesListBuilder

New in version NX10.0.0.

License requirements: None.

ShowXmlReport

CopyPasteNewBuilder.ShowXmlReport

Returns or sets the flag to indicate whether or not to show the xml report on copy paste results

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

Getter Method

Signature ShowXmlReport

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ShowXmlReport

Parameters:showXmlReport (bool) –

New in version NX11.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

Method Detail

AutoAssignAttributes

CopyPasteNewBuilder.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

CopyPasteNewBuilder.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

CopyPasteNewBuilder.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.

CreateLogicalObjects

CopyPasteNewBuilder.CreateLogicalObjects

Creates the pre-creation logical objects

Signature CreateLogicalObjects()

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

New in version NX8.5.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

GetOperationFailures

CopyPasteNewBuilder.GetOperationFailures

Gets the operation failure error list object

Signature GetOperationFailures()

Returns:List of errors encountered during the copy parts
Return type:NXOpen.ErrorList

New in version NX10.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

Validate

CopyPasteNewBuilder.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.