WeldCut2Builder Class — NXOpen Python API Reference 12.0.0 documentation

# WeldCut2Builder Class

class `NXOpen.Features.ShipDesign.``WeldCut2Builder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.ShipDesign.WeldCut2` builder

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

  Default values.

  Property | Value
  --- | ---
  DistanceTolerance | 0.0254 (millimeters part), 0.001 (inches part)

  New in version NX8.0.1.

# Properties

Property | Description
--- | ---
CSYSTargetFace | Returns the csys target face.
CoordinateSystem | Returns or sets the placement CSYS of the weld cut The coordinate system is only used for the SpecifyCSYS placement method.
CornerPoint | Returns or sets the corner point as weld location.
CornerTargetFace | Returns the corner target face.
CurveTargetFace | Returns the curve target face.
DistanceTolerance | Returns or sets the distance tolerance.
GuideCurve | Returns the guide curve to position the weld cut.
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 method used to define the placement of the weld cut
Spreadsheet | Returns the spreadsheet builder.
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
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

WeldCut2BuilderCreationMethod Enumeration | Creation method used to define the placement of the weld cut

# Property Detail

## CSYSTargetFace

`WeldCut2Builder.``CSYSTargetFace`

  Returns the csys target face.

  This csys target face is only used for the SpecifyCSYS placement method.

  `-------------------------------------`

  Getter Method

  Signature `CSYSTargetFace`

  Returns: |
  Return type: | `NXOpen.SelectFace`

  New in version NX8.0.1.

  License requirements: None.

## CoordinateSystem

`WeldCut2Builder.``CoordinateSystem`

  Returns or sets the placement CSYS of the weld cut The coordinate system is only used for the SpecifyCSYS placement method.

  `-------------------------------------`

  Getter Method

  Signature `CoordinateSystem`

  Returns: |
  Return type: | `NXOpen.CoordinateSystem`

  New in version NX8.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CoordinateSystem`

  Parameters: | coordinateSystem (`NXOpen.CoordinateSystem`) –

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## CornerPoint

`WeldCut2Builder.``CornerPoint`

  Returns or sets the corner point as weld location.

  The weld location is only used for the Corner placement method.

  `-------------------------------------`

  Getter Method

  Signature `CornerPoint`

  Returns: |
  Return type: | `NXOpen.Point`

  New in version NX8.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CornerPoint`

  Parameters: | weldLocation (`NXOpen.Point`) –

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## CornerTargetFace

`WeldCut2Builder.``CornerTargetFace`

  Returns the corner target face.

  This corner target face is only used for the Corner placement method.

  `-------------------------------------`

  Getter Method

  Signature `CornerTargetFace`

  Returns: |
  Return type: | `NXOpen.SelectFace`

  New in version NX8.0.1.

  License requirements: None.

## CurveTargetFace

`WeldCut2Builder.``CurveTargetFace`

  Returns the curve target face.

  This curve target face is only used for the AlongGuide placement method.

  `-------------------------------------`

  Getter Method

  Signature `CurveTargetFace`

  Returns: |
  Return type: | `NXOpen.SelectFace`

  New in version NX8.0.1.

  License requirements: None.

## DistanceTolerance

`WeldCut2Builder.``DistanceTolerance`

  Returns or sets the distance tolerance.

  `-------------------------------------`

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX8.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## GuideCurve

`WeldCut2Builder.``GuideCurve`

  Returns the guide curve to position the weld cut.

  The select guide curve is only used for the AlongGuide placement method.

  `-------------------------------------`

  Getter Method

  Signature `GuideCurve`

  Returns: |
  Return type: | `NXOpen.SelectTaggedObject`

  New in version NX8.0.1.

  License requirements: None.

## PlacementType

`WeldCut2Builder.``PlacementType`

  Returns or sets the method used to define the placement of the weld cut

  `-------------------------------------`

  Getter Method

  Signature `PlacementType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.WeldCut2BuilderCreationMethod`

  New in version NX8.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlacementType`

  Parameters: | placementType (`NXOpen.Features.ShipDesign.WeldCut2BuilderCreationMethod`) –

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## Spreadsheet

`WeldCut2Builder.``Spreadsheet`

  Returns the spreadsheet builder.

  Users can specify the Weldout using a single sketch. The sketch type and its parameters are controlled by the `NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder`.

  `-------------------------------------`

  Getter Method

  Signature `Spreadsheet`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder`

  New in version NX8.0.1.

  License requirements: None.

# Method Detail

## Validate

`WeldCut2Builder.``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.