PlugSlotBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PlugSlotBuilder Class

class `NXOpen.Weld.``PlugSlotBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Weld.PlugSlot` builder

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

  Default values.

  Property | Value
  --- | ---
  AssignWeldPMI | 0
  ContourDepth.Value | 2.54 (millimeters part), .1 (inches part)
  ContourHeight.Value | 2.54 (millimeters part), .1 (inches part)
  ContourType | None
  FieldWeld | 0

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
AssignWeldPMI | Returns or sets the assign weld pmi
Characteristics | Returns the characteristics
ContourDepth | Returns the contour depth
ContourHeight | Returns the contour height needed for cap
ContourType | Returns or sets the contour type
Edge1 | Returns the edge of the hole or slot on face1
Face1 | Returns the face1
Face2 | Returns the face2
FieldWeld | Returns or sets the field weld
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
SeedFace1 | Returns or sets the top face on face1
SeedFace2 | Returns or sets the bottom face from which the weld will be extruded towards the top
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

PlugSlotBuilderArcProcessEnum Enumeration | arc process for the weld feature
PlugSlotBuilderEnumContour Enumeration | contour type

# Property Detail

## AssignWeldPMI

`PlugSlotBuilder.``AssignWeldPMI`

  Returns or sets the assign weld pmi

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

  Getter Method

  Signature `AssignWeldPMI`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AssignWeldPMI`

  Parameters: | assignWeldPMI (bool) –

  New in version NX8.0.0.

  License requirements: None.

## Characteristics

`PlugSlotBuilder.``Characteristics`

  Returns the characteristics

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

  Getter Method

  Signature `Characteristics`

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

  New in version NX8.0.0.

  License requirements: None.

## ContourDepth

`PlugSlotBuilder.``ContourDepth`

  Returns the contour depth

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

  Getter Method

  Signature `ContourDepth`

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

  New in version NX8.0.0.

  License requirements: None.

## ContourHeight

`PlugSlotBuilder.``ContourHeight`

  Returns the contour height needed for cap

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

  Getter Method

  Signature `ContourHeight`

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

  New in version NX8.0.0.

  License requirements: None.

## ContourType

`PlugSlotBuilder.``ContourType`

  Returns or sets the contour type

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

  Getter Method

  Signature `ContourType`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ContourType`

  Parameters: | contourType (`NXOpen.Weld.PlugSlotBuilderEnumContour`) –

  New in version NX8.0.0.

  License requirements: None.

## Edge1

`PlugSlotBuilder.``Edge1`

  Returns the edge of the hole or slot on face1

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

  Getter Method

  Signature `Edge1`

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

  New in version NX8.0.0.

  License requirements: None.

## Face1

`PlugSlotBuilder.``Face1`

  Returns the face1

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

  Getter Method

  Signature `Face1`

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

  New in version NX8.0.0.

  License requirements: None.

## Face2

`PlugSlotBuilder.``Face2`

  Returns the face2

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

  Getter Method

  Signature `Face2`

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

  New in version NX8.0.0.

  License requirements: None.

## FieldWeld

`PlugSlotBuilder.``FieldWeld`

  Returns or sets the field weld

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

  Getter Method

  Signature `FieldWeld`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FieldWeld`

  Parameters: | fieldWeld (bool) –

  New in version NX8.0.0.

  License requirements: None.

## SeedFace1

`PlugSlotBuilder.``SeedFace1`

  Returns or sets the top face on face1

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

  Getter Method

  Signature `SeedFace1`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SeedFace1`

  Parameters: | seedFace1 (`NXOpen.Face`) –

  New in version NX8.0.0.

  License requirements: None.

## SeedFace2

`PlugSlotBuilder.``SeedFace2`

  Returns or sets the bottom face from which the weld will be extruded towards the top

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

  Getter Method

  Signature `SeedFace2`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SeedFace2`

  Parameters: | seedFace2 (`NXOpen.Face`) –

  New in version NX8.0.0.

  License requirements: None.

# Method Detail

## Validate

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