MirrorShipStructureBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
MirrorShipStructureBuilder
¶ Bases:
NXOpen.Builder
Copy 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.CreateMirrorShipStructureBuilder()
Default 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. |
ApplicationType | Returns or sets the application type, which is ship basic design or ship detail design. |
LinearToleranceFactor | Returns or sets the linear tolerance factor used for the geometry comparison and defined in the customer default. |
MirrorApproachOption | Returns or sets an option to determines the approach to copy and mirror ship standard parts. |
MirrorPlane | Returns or sets the mirror plane. |
OriginalFeatures | Returns the list of features to Mirror Copy. |
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. |
SelectionType | Returns or sets the selection type, which is structure system or feature. |
Tag | Returns the Tag for this object. |
TargetPart | Returns the target parts or components where the selected features will be mirror copied into. |
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. |
SortComponentByInterPartDependency | Sort components by inter-part dependency and return dependency circles. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
MirrorShipStructureBuilderAppTypes Enumeration | Settings to indicate the current application type. |
MirrorShipStructureBuilderMirrorApproach Enumeration | Represents the approach of mirroring ship standard parts. |
MirrorShipStructureBuilderTypes Enumeration | Settings to indicate the selection type of ship feature. |
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
Parameters: angularTolerance (float) – New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ApplicationType¶
-
MirrorShipStructureBuilder.
ApplicationType
¶ Returns or sets the application type, which is ship basic design or ship detail design.
-------------------------------------
Getter Method
Signature
ApplicationType
Returns: Return type: NXOpen.Features.ShipDesign.MirrorShipStructureBuilderAppTypes
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ApplicationType
Parameters: type ( NXOpen.Features.ShipDesign.MirrorShipStructureBuilderAppTypes
) –New in version NX11.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic 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
Parameters: linearToleranceFactor (float) – New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
MirrorApproachOption¶
-
MirrorShipStructureBuilder.
MirrorApproachOption
¶ Returns or sets an option to determines the approach to copy and mirror ship standard parts.
-------------------------------------
Getter Method
Signature
MirrorApproachOption
Returns: Return type: NXOpen.Features.ShipDesign.MirrorShipStructureBuilderMirrorApproach
New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
MirrorApproachOption
Parameters: mirrorApproachOption ( NXOpen.Features.ShipDesign.MirrorShipStructureBuilderMirrorApproach
) –New in version NX11.0.2.
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.Plane
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MirrorPlane
Parameters: mirrorPlane ( NXOpen.Plane
) –New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
OriginalFeatures¶
-
MirrorShipStructureBuilder.
OriginalFeatures
¶ Returns the list of features to Mirror Copy.
-------------------------------------
Getter Method
Signature
OriginalFeatures
Returns: Return type: NXOpen.Features.SelectFeatureList
New in version NX11.0.0.
License requirements: None.
OriginalParts¶
-
MirrorShipStructureBuilder.
OriginalParts
¶ Returns the list of parts (or components) to Mirror Copy.
-------------------------------------
Getter Method
Signature
OriginalParts
Returns: Return type: NXOpen.Assemblies.SelectComponentList
New 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
Parameters: reportMirrorResultXML (bool) – New in version NX10.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
SelectionType¶
-
MirrorShipStructureBuilder.
SelectionType
¶ Returns or sets the selection type, which is structure system or feature.
-------------------------------------
Getter Method
Signature
SelectionType
Returns: Return type: NXOpen.Features.ShipDesign.MirrorShipStructureBuilderTypes
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectionType
Parameters: type ( NXOpen.Features.ShipDesign.MirrorShipStructureBuilderTypes
) –New in version NX11.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
TargetPart¶
-
MirrorShipStructureBuilder.
TargetPart
¶ Returns the target parts or components where the selected features will be mirror copied into.
-------------------------------------
Getter Method
Signature
TargetPart
Returns: Return type: NXOpen.Assemblies.SelectComponentList
New in version NX11.0.0.
License requirements: None.
Method Detail¶
SortComponentByInterPartDependency¶
-
MirrorShipStructureBuilder.
SortComponentByInterPartDependency
¶ Sort components by inter-part dependency and return dependency circles.
Signature
SortComponentByInterPartDependency()
Returns: a tuple Return type: A tuple consisting of (errorCode, nonBreakableCircles, brokenCircles) errorCode is a int. nonBreakableCircles is a list of str. brokenCircles is a list of str. New in version NX11.0.0.
License requirements: None.
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.