Cutout2Builder Class¶
-
class
NXOpen.Features.ShipDesign.
Cutout2Builder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.Cutout2
builderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateCutout2Builder()
Default values.
Property Value AngularDimension.Value 0 PlacementType Face2Lines ReferenceOffset1.Value 0 (millimeters part), 0 (inches part) ReferenceOffset2.Value 0 (millimeters part), 0 (inches part) ReferenceOffset3.Value 0 (millimeters part), 0 (inches part) New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
AngularDimension | Returns the angular dimension (used only for Face2Lines, Faces2Surfaces, FacesBetweenSurfacesSurface, FacesCentered) |
CoordSystem | Returns or sets the coord system (only used for: SpecifyCSYS) |
HorizontalReference | Returns or sets the horizontal reference (optional, used only for Faces2Surfaces, FacesBetweenSurfacesSurface, and FacesCentered) |
LinearOffset1 | Returns the linear offset1 (replaced by ReferenceOffset1 in NX8. |
LinearOffset2 | Returns the linear offset2 (replaced by ReferenceOffset2 in NX8. |
ManufacturingInformation | Returns the manufacturing stock builder that holds the manufacturing data. |
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 |
PlacementType | Returns or sets the placement type |
ReferenceOffset1 | Returns the reference offset1 (used only for Face2Lines, and Faces2Surfaces ) |
ReferenceOffset2 | Returns the reference offset2 (used only for Face2Lines, and Faces2Surfaces) |
ReferenceOffset3 | Returns the reference offset3 (used only for FacesBetweenSurfacesSurface) |
ReverseDirection1 | Returns or sets the reverse direction1 (used only for Face2Lines, and Faces2Surfaces ) |
ReverseDirection2 | Returns or sets the reverse direction2 (used only for Face2Lines, and Faces2Surfaces) |
ReverseDirection3 | Returns or sets the reverse direction3 (used only for FacesBetweenSurfacesSurface) |
SelectCSYSFace | Returns the select csysface (only used for: SpecifyCSYS) |
SelectLine1 | Returns the select line1 (replaced by SelectReference1 in NX8. |
SelectLine2 | Returns the select line2 (replaced by SelectReference2 in NX8. |
SelectReference1 | Returns the reference1 (used only for Face2Lines, Faces2Surfaces, and FacesBetweenSurfacesSurface) |
SelectReference2 | Returns the reference2 (used only for Face2Lines, Faces2Surfaces, and FacesBetweenSurfacesSurface) |
SelectReference3 | Returns the reference3 (used only for FacesBetweenSurfacesSurface) |
SelectTargetFace | Returns the select target face |
SelectTargetFaces | Returns the target faces (used only for: Faces2Surfaces, FacesBetweenSurfacesSurface, and FacesCentered) |
SketchBlock | Returns the sketch block. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
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. |
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¶
Cutout2BuilderCreationMethod Enumeration | available methods used to place a cutout object |
Property Detail¶
AngularDimension¶
-
Cutout2Builder.
AngularDimension
¶ Returns the angular dimension (used only for Face2Lines, Faces2Surfaces, FacesBetweenSurfacesSurface, FacesCentered)
-------------------------------------
Getter Method
Signature
AngularDimension()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
CoordSystem¶
-
Cutout2Builder.
CoordSystem
¶ Returns or sets the coord system (only used for: SpecifyCSYS)
-------------------------------------
Getter Method
Signature
CoordSystem()
Returns: Return type: NXOpen.CoordinateSystem
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoordSystem(coordSystem)
Parameters: coordSystem ( NXOpen.CoordinateSystem
) –New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
HorizontalReference¶
-
Cutout2Builder.
HorizontalReference
¶ Returns or sets the horizontal reference (optional, used only for Faces2Surfaces, FacesBetweenSurfacesSurface, and FacesCentered)
-------------------------------------
Getter Method
Signature
HorizontalReference()
Returns: Return type: NXOpen.Direction
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalReference(horizontalReference)
Parameters: horizontalReference ( NXOpen.Direction
) –New in version NX8.5.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
LinearOffset1¶
-
Cutout2Builder.
LinearOffset1
¶ Returns the linear offset1 (replaced by ReferenceOffset1 in NX8.
-------------------------------------
Getter Method
Signature
LinearOffset1()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
LinearOffset2¶
-
Cutout2Builder.
LinearOffset2
¶ Returns the linear offset2 (replaced by ReferenceOffset2 in NX8.
-------------------------------------
Getter Method
Signature
LinearOffset2()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
ManufacturingInformation¶
-
Cutout2Builder.
ManufacturingInformation
¶ Returns the manufacturing stock builder that holds the manufacturing data.
-------------------------------------
Getter Method
Signature
ManufacturingInformation()
Returns: Return type: NXOpen.Features.ShipDesign.ManufacturingStockBuilder
New in version NX8.5.1.
License requirements: None.
PlacementType¶
-
Cutout2Builder.
PlacementType
¶ Returns or sets the placement type
-------------------------------------
Getter Method
Signature
PlacementType()
Returns: Return type: NXOpen.Features.ShipDesign.Cutout2BuilderCreationMethod
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PlacementType(placementType)
Parameters: placementType ( NXOpen.Features.ShipDesign.Cutout2BuilderCreationMethod
) –New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ReferenceOffset1¶
-
Cutout2Builder.
ReferenceOffset1
¶ Returns the reference offset1 (used only for Face2Lines, and Faces2Surfaces )
-------------------------------------
Getter Method
Signature
ReferenceOffset1()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
ReferenceOffset2¶
-
Cutout2Builder.
ReferenceOffset2
¶ Returns the reference offset2 (used only for Face2Lines, and Faces2Surfaces)
-------------------------------------
Getter Method
Signature
ReferenceOffset2()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
ReferenceOffset3¶
-
Cutout2Builder.
ReferenceOffset3
¶ Returns the reference offset3 (used only for FacesBetweenSurfacesSurface)
-------------------------------------
Getter Method
Signature
ReferenceOffset3()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
ReverseDirection1¶
-
Cutout2Builder.
ReverseDirection1
¶ Returns or sets the reverse direction1 (used only for Face2Lines, and Faces2Surfaces )
-------------------------------------
Getter Method
Signature
ReverseDirection1()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDirection1(reverseDirection1)
Parameters: reverseDirection1 (bool) – New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ReverseDirection2¶
-
Cutout2Builder.
ReverseDirection2
¶ Returns or sets the reverse direction2 (used only for Face2Lines, and Faces2Surfaces)
-------------------------------------
Getter Method
Signature
ReverseDirection2()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDirection2(reverseDirection2)
Parameters: reverseDirection2 (bool) – New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ReverseDirection3¶
-
Cutout2Builder.
ReverseDirection3
¶ Returns or sets the reverse direction3 (used only for FacesBetweenSurfacesSurface)
-------------------------------------
Getter Method
Signature
ReverseDirection3()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDirection3(reverseDirection3)
Parameters: reverseDirection3 (bool) – New in version NX8.5.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
SelectCSYSFace¶
-
Cutout2Builder.
SelectCSYSFace
¶ Returns the select csysface (only used for: SpecifyCSYS)
-------------------------------------
Getter Method
Signature
SelectCSYSFace()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.0.0.
License requirements: None.
SelectLine1¶
-
Cutout2Builder.
SelectLine1
¶ Returns the select line1 (replaced by SelectReference1 in NX8.
-------------------------------------
Getter Method
Signature
SelectLine1()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.0.0.
License requirements: None.
SelectLine2¶
-
Cutout2Builder.
SelectLine2
¶ Returns the select line2 (replaced by SelectReference2 in NX8.
-------------------------------------
Getter Method
Signature
SelectLine2()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.0.0.
License requirements: None.
SelectReference1¶
-
Cutout2Builder.
SelectReference1
¶ Returns the reference1 (used only for Face2Lines, Faces2Surfaces, and FacesBetweenSurfacesSurface)
-------------------------------------
Getter Method
Signature
SelectReference1()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.5.0.
License requirements: None.
SelectReference2¶
-
Cutout2Builder.
SelectReference2
¶ Returns the reference2 (used only for Face2Lines, Faces2Surfaces, and FacesBetweenSurfacesSurface)
-------------------------------------
Getter Method
Signature
SelectReference2()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.5.0.
License requirements: None.
SelectReference3¶
-
Cutout2Builder.
SelectReference3
¶ Returns the reference3 (used only for FacesBetweenSurfacesSurface)
-------------------------------------
Getter Method
Signature
SelectReference3()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.5.0.
License requirements: None.
SelectTargetFace¶
-
Cutout2Builder.
SelectTargetFace
¶ Returns the select target face
-------------------------------------
Getter Method
Signature
SelectTargetFace()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.0.0.
License requirements: None.
SelectTargetFaces¶
-
Cutout2Builder.
SelectTargetFaces
¶ Returns the target faces (used only for: Faces2Surfaces, FacesBetweenSurfacesSurface, and FacesCentered)
-------------------------------------
Getter Method
Signature
SelectTargetFaces()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX8.5.0.
License requirements: None.
SketchBlock¶
-
Cutout2Builder.
SketchBlock
¶ Returns the sketch block.
Users can specify the Cutout using a single sketch. The sketch type and its parameters are controlled by the
NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
.-------------------------------------
Getter Method
Signature
SketchBlock()
Returns: Return type: NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
New in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
Cutout2Builder.
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.