SurfaceWeldBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SurfaceWeldBuilder Class

class `NXOpen.Weld.``SurfaceWeldBuilder`

  Bases: `NXOpen.Weld.StructureWeldBuilder`

  Use to create or edit a `NXOpen.Weld.SurfaceWeld` feature.

  To create a new instance of this class, use `NXOpen.Weld.WeldManager.CreateSurfaceWeldBuilder()`

  Default values.

  Property | Value
  --- | ---
  Thickness.Value | 12.2 (millimeters part), 0.5 (inches part)
  Width.Value | 12.2 (millimeters part), 0.5 (inches part)

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
Boundary | Returns the section defining all the boundaries to use for creating the surface weld.
Characteristics | Returns the characteristics to assign to the object created.
Destination | Returns or sets the option specifying the destination for this surface weld feature.
DistanceTolerance | Returns or sets the distance tolerance for constructing the surface weld.
LineColorFontWidth | Returns the color, font, and width of the surface weld output curve.
NamePrefix | Returns or sets the prefix used for the surface weld Design Feature name in Fourth Generation Design mode.
Panel | Returns the collector containing the faces to create the surface weld on.
ProjectionDirection | Returns the project direction, which is used to project the boundary curves to the plate mold face.
Tag | Returns the Tag for this object.
Thickness | Returns the expression containing the value of the thickness of the surface weld.
Width | Returns the expression containing the value of the width of the surface weld if only the centerline is specified.

# 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.
GetCommittedComponents | This method returns the component parts that are created by `Builder.Commit()`.
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

SurfaceWeldBuilderDestinationTypes Enumeration | The option specifying where the surface weld feature should be created.

# Property Detail

## Boundary

`SurfaceWeldBuilder.``Boundary`

  Returns the section defining all the boundaries to use for creating the surface weld.

  The largest boundary will be treated as the primary exterior boundary.

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

  Getter Method

  Signature `Boundary`

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

  New in version NX9.0.0.

  License requirements: None.

## Characteristics

`SurfaceWeldBuilder.``Characteristics`

  Returns the characteristics to assign to the object created.

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

  Getter Method

  Signature `Characteristics`

  Returns: |
  Return type: | `NXOpen.Weld.CharacteristicsBuilder`

  New in version NX9.0.0.

  License requirements: None.

## Destination

`SurfaceWeldBuilder.``Destination`

  Returns or sets the option specifying the destination for this surface weld feature.

  Only applicable during create.

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

  Getter Method

  Signature `Destination`

  Returns: |
  Return type: | `NXOpen.Weld.SurfaceWeldBuilderDestinationTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Destination`

  Parameters: | destination (`NXOpen.Weld.SurfaceWeldBuilderDestinationTypes`) –

  New in version NX9.0.0.

  License requirements: structure_weld (“STRUCTURE WELD”)

## DistanceTolerance

`SurfaceWeldBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance for constructing the surface weld.

  Uses the modeling tolerance during creation.

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX9.0.0.

  License requirements: structure_weld (“STRUCTURE WELD”)

## LineColorFontWidth

`SurfaceWeldBuilder.``LineColorFontWidth`

  Returns the color, font, and width of the surface weld output curve.

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

  Getter Method

  Signature `LineColorFontWidth`

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

  New in version NX9.0.0.

  License requirements: None.

## NamePrefix

`SurfaceWeldBuilder.``NamePrefix`

  Returns or sets the prefix used for the surface weld Design Feature name in Fourth Generation Design mode.

  Only applicable during create.

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

  Getter Method

  Signature `NamePrefix`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NamePrefix`

  Parameters: | prefix (str) –

  New in version NX9.0.0.

  License requirements: structure_weld (“STRUCTURE WELD”)

## Panel

`SurfaceWeldBuilder.``Panel`

  Returns the collector containing the faces to create the surface weld on.

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

  Getter Method

  Signature `Panel`

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

  New in version NX9.0.0.

  License requirements: None.

## ProjectionDirection

`SurfaceWeldBuilder.``ProjectionDirection`

  Returns the project direction, which is used to project the boundary curves to the plate mold face.

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

  Getter Method

  Signature `ProjectionDirection`

  Returns: | Projection Options data.
  Return type: | `NXOpen.GeometricUtilities.ProjectionOptions`

  New in version NX9.0.0.

  License requirements: None.

## Thickness

`SurfaceWeldBuilder.``Thickness`

  Returns the expression containing the value of the thickness of the surface weld.

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

  Getter Method

  Signature `Thickness`

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

  New in version NX9.0.0.

  License requirements: None.

## Width

`SurfaceWeldBuilder.``Width`

  Returns the expression containing the value of the width of the surface weld if only the centerline is specified.

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

  Getter Method

  Signature `Width`

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

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## Validate

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