MirrorShipStructureBuilder Class¶
-
class
NXOpen.Features.ShipDesign.MirrorShipStructureBuilder¶ Bases:
NXOpen.BuilderCopy the selected parts (components) about the Mirror Plane with full model history and feature data.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateMirrorShipStructureBuilderDefault values.
Property Value ReportMirrorResultXML 1 New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| AngularTolerance | Returns or sets the angular tolerance used for geometry comparison and defined in the customer defaults. |
| LinearToleranceFactor | Returns or sets the linear tolerance factor used for the geometry comparison and defined in the customer default. |
| MirrorPlane | Returns or sets the mirror plane. |
| OriginalParts | Returns the list of parts (or components) to Mirror Copy. |
| ReportMirrorResultXML | Returns or sets an XML report with mirror process information will be shown if set to true. |
| 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. |
Property Detail¶
AngularTolerance¶
-
MirrorShipStructureBuilder.AngularTolerance¶ Returns or sets the angular tolerance used for geometry comparison and defined in the customer defaults.
-------------------------------------Getter Method
Signature
AngularTolerance()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngularTolerance(angularTolerance)Parameters: angularTolerance (float) – New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
LinearToleranceFactor¶
-
MirrorShipStructureBuilder.LinearToleranceFactor¶ Returns or sets the linear tolerance factor used for the geometry comparison and defined in the customer default.
-------------------------------------Getter Method
Signature
LinearToleranceFactor()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LinearToleranceFactor(linearToleranceFactor)Parameters: linearToleranceFactor (float) – New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
MirrorPlane¶
-
MirrorShipStructureBuilder.MirrorPlane¶ Returns or sets the mirror plane.
-------------------------------------Getter Method
Signature
MirrorPlane()Returns: Return type: NXOpen.PlaneNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MirrorPlane(mirrorPlane)Parameters: mirrorPlane ( NXOpen.Plane) –New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
OriginalParts¶
-
MirrorShipStructureBuilder.OriginalParts¶ Returns the list of parts (or components) to Mirror Copy.
-------------------------------------Getter Method
Signature
OriginalParts()Returns: Return type: NXOpen.Assemblies.SelectComponentListNew in version NX10.0.0.
License requirements: None.
ReportMirrorResultXML¶
-
MirrorShipStructureBuilder.ReportMirrorResultXML¶ Returns or sets an XML report with mirror process information will be shown if set to true.
-------------------------------------Getter Method
Signature
ReportMirrorResultXML()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReportMirrorResultXML(reportMirrorResultXML)Parameters: reportMirrorResultXML (bool) – New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
Method Detail¶
Validate¶
-
MirrorShipStructureBuilder.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.