WeldBeadSizeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# WeldBeadSizeBuilder Class

class `NXOpen.Weld.``WeldBeadSizeBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  This builder is used to define the bead shape.

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

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
CustomSection | Returns the section containing the custom bead shape.
PathLocation | Returns the location on the path to place the bead shape.
RectangleBase | Returns or sets the base length of a rectangle shaped bead.
RectangleHeight | Returns or sets the height of a rectangle shaped bead.
SemiMajor | Returns or sets the semi the semi major size of an ellipse shaped bead.
SemiMinor | Returns or sets the semi minor size of an ellipse shaped bead.
SizeString | Returns or sets the standard size setting.
Tag | Returns the Tag for this object.
ThroatThickness | Returns or sets the throat thickness of a triangular shaped bead.
TriangleBase | Returns or sets the horizontal leg length of a triangular shaped bead.
TriangleHeight | Returns or sets the vertical leg length of a triangular shaped bead.
TriangleMethod | Returns or sets the method used to construct the triangle shape.
TriangleType | Returns or sets the method used to indicate the type of triangle to create.
TubeDiameter | Returns or sets the diameter size of the tube shape.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

WeldBeadSizeBuilderSize Enumeration | Settings to indicate which standard size to use from the customer defaults file.
WeldBeadSizeBuilderTriangleMethodType Enumeration | Settings to indicate the type of method used to build a triangle shape.
WeldBeadSizeBuilderTriangleTypes Enumeration | Settings to indicate the type of triangle.

# Property Detail

## CustomSection

`WeldBeadSizeBuilder.``CustomSection`

  Returns the section containing the custom bead shape.

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

  Getter Method

  Signature `CustomSection`

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

  New in version NX7.5.0.

  License requirements: None.

## PathLocation

`WeldBeadSizeBuilder.``PathLocation`

  Returns the location on the path to place the bead shape.

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

  Getter Method

  Signature `PathLocation`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.OnPathDimensionBuilder`

  New in version NX7.5.0.

  License requirements: None.

## RectangleBase

`WeldBeadSizeBuilder.``RectangleBase`

  Returns or sets the base length of a rectangle shaped bead.

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

  Getter Method

  Signature `RectangleBase`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RectangleBase`

  Parameters: | length (float) –

  New in version NX11.0.0.

  License requirements: ugweld (“UG WELD”)

## RectangleHeight

`WeldBeadSizeBuilder.``RectangleHeight`

  Returns or sets the height of a rectangle shaped bead.

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

  Getter Method

  Signature `RectangleHeight`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RectangleHeight`

  Parameters: | height (float) –

  New in version NX11.0.0.

  License requirements: ugweld (“UG WELD”)

## SemiMajor

`WeldBeadSizeBuilder.``SemiMajor`

  Returns or sets the semi the semi major size of an ellipse shaped bead.

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

  Getter Method

  Signature `SemiMajor`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SemiMajor`

  Parameters: | semiMajor (float) –

  New in version NX7.5.0.

  License requirements: ugweld (“UG WELD”)

## SemiMinor

`WeldBeadSizeBuilder.``SemiMinor`

  Returns or sets the semi minor size of an ellipse shaped bead.

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

  Getter Method

  Signature `SemiMinor`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SemiMinor`

  Parameters: | semiMinor (float) –

  New in version NX7.5.0.

  License requirements: ugweld (“UG WELD”)

## SizeString

`WeldBeadSizeBuilder.``SizeString`

  Returns or sets the standard size setting.

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

  Getter Method

  Signature `SizeString`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SizeString`

  Parameters: | sizeString (`NXOpen.Weld.WeldBeadSizeBuilderSize`) –

  New in version NX7.5.0.

  License requirements: ugweld (“UG WELD”)

## ThroatThickness

`WeldBeadSizeBuilder.``ThroatThickness`

  Returns or sets the throat thickness of a triangular shaped bead.

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

  Getter Method

  Signature `ThroatThickness`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ThroatThickness`

  Parameters: | throatThickness (float) –

  New in version NX11.0.0.

  License requirements: ugweld (“UG WELD”)

## TriangleBase

`WeldBeadSizeBuilder.``TriangleBase`

  Returns or sets the horizontal leg length of a triangular shaped bead.

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

  Getter Method

  Signature `TriangleBase`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TriangleBase`

  Parameters: | length (float) –

  New in version NX11.0.0.

  License requirements: ugweld (“UG WELD”)

## TriangleHeight

`WeldBeadSizeBuilder.``TriangleHeight`

  Returns or sets the vertical leg length of a triangular shaped bead.

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

  Getter Method

  Signature `TriangleHeight`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TriangleHeight`

  Parameters: | length (float) –

  New in version NX11.0.0.

  License requirements: ugweld (“UG WELD”)

## TriangleMethod

`WeldBeadSizeBuilder.``TriangleMethod`

  Returns or sets the method used to construct the triangle shape.

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

  Getter Method

  Signature `TriangleMethod`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TriangleMethod`

  Parameters: | method (`NXOpen.Weld.WeldBeadSizeBuilderTriangleMethodType`) –

  New in version NX11.0.0.

  License requirements: ugweld (“UG WELD”)

## TriangleType

`WeldBeadSizeBuilder.``TriangleType`

  Returns or sets the method used to indicate the type of triangle to create.

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

  Getter Method

  Signature `TriangleType`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TriangleType`

  Parameters: | type (`NXOpen.Weld.WeldBeadSizeBuilderTriangleTypes`) –

  New in version NX11.0.0.

  License requirements: ugweld (“UG WELD”)

## TubeDiameter

`WeldBeadSizeBuilder.``TubeDiameter`

  Returns or sets the diameter size of the tube shape.

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

  Getter Method

  Signature `TubeDiameter`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TubeDiameter`

  Parameters: | tubeDiameter (float) –

  New in version NX7.5.0.

  License requirements: ugweld (“UG WELD”)

# Method Detail

## Validate

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