CopyObjectsBuilder Class¶
-
class
NXOpen.Features.ShipDesign.CopyObjectsBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.ShipDesign.CopyObjectsBuilderIt is used in Ship Building Application.The operation copies one or more components and pastes them to new parts while re-parenting and maintaining WAVE links
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateCopyObjectsBuilder()Default values.
Property Value AngularTolerance 5 CopySection false ObjectType Part New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| AngularTolerance | Returns or sets the value of angular tolerance is used to define the angular difference from the qualified candidate face / plane normal to source face / plane normal. |
| CopyFrom | Returns the plane where the source objects to be copied from. |
| CopySection | Returns or sets the flag is used to define if linear tolerance on UI would be used when matching geometry. |
| CopyTo | Returns the target objects where the source objects to be copied to. |
| InputObjects | Returns the source input objects to copy. |
| LinearTolerance | Returns or sets the value of linear tolerance is used to define the tolerance between candidate object and transformed source object. |
| ObjectType | Returns or sets the type of objects to copy. |
| 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 basic design part results |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| 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. |
| GetObject | Returns the object currently being edited by this builder. |
| 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. |
Enumerations¶
| CopyObjectsBuilderType Enumeration | Type of Source Objects. |
Property Detail¶
AngularTolerance¶
-
CopyObjectsBuilder.AngularTolerance¶ Returns or sets the value of angular tolerance is used to define the angular difference from the 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(tolerance)Parameters: tolerance (float) – New in version NX11.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
CopyFrom¶
-
CopyObjectsBuilder.CopyFrom¶ Returns the plane where the source objects to be copied from.
-------------------------------------Getter Method
Signature
CopyFrom()Returns: Return type: NXOpen.SelectNXObjectNew in version NX10.0.0.
License requirements: None.
CopySection¶
-
CopyObjectsBuilder.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(copySection)Parameters: copySection (bool) – New in version NX11.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
CopyTo¶
-
CopyObjectsBuilder.CopyTo¶ Returns the target objects where the source objects to be copied to.
-------------------------------------Getter Method
Signature
CopyTo()Returns: Component or Plane Return type: NXOpen.SelectNXObjectListNew in version NX10.0.0.
License requirements: None.
InputObjects¶
-
CopyObjectsBuilder.InputObjects¶ Returns the source input objects to copy.
-------------------------------------Getter Method
Signature
InputObjects()Returns: Component or Feature Return type: NXOpen.SelectNXObjectListNew in version NX10.0.0.
License requirements: None.
LinearTolerance¶
-
CopyObjectsBuilder.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(tolerance)Parameters: tolerance (float) – New in version NX11.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
ObjectType¶
-
CopyObjectsBuilder.ObjectType¶ Returns or sets the type of objects to copy.
-------------------------------------Getter Method
Signature
ObjectType()Returns: Return type: NXOpen.Features.ShipDesign.CopyObjectsBuilderTypeNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ObjectType(objectType)Parameters: objectType ( NXOpen.Features.ShipDesign.CopyObjectsBuilderType) –New in version NX10.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
ShipNames¶
-
CopyObjectsBuilder.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.ShipNamesListBuilderNew in version NX10.0.0.
License requirements: None.
ShowXmlReport¶
-
CopyObjectsBuilder.ShowXmlReport¶ Returns or sets the flag to indicate whether or not to show the xml report on copy basic design part results
-------------------------------------Getter Method
Signature
ShowXmlReport()Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowXmlReport(showXmlReport)Parameters: showXmlReport (bool) – New in version NX11.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
Method Detail¶
Validate¶
-
CopyObjectsBuilder.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.