## On this page

  

 

 # `SpotWeldGroup`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Connections.SpotWeldGroup"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Connections.SpotWeldGroup

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a SpotWeldGroup.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#SpotWeldGroup.Activate)Activate the current object.[`AddComment`](#SpotWeldGroup.AddComment)Creates a new child Comment.[`AddImage`](#SpotWeldGroup.AddImage)Creates a new child Image.[`AddSpotWeldConnection`](#SpotWeldGroup.AddSpotWeldConnection)Creates a new child SpotWeldConnection.[`CopyTo`](#SpotWeldGroup.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#SpotWeldGroup.CreateParameter)Creates a new parameter for a Property.[`Duplicate`](#SpotWeldGroup.Duplicate)Creates a copy of the current DataModelObject.[`ExportToFile`](#SpotWeldGroup.ExportToFile)Exports all spot welds to user selected path.[`GenerateSpotWeldConnections`](#SpotWeldGroup.GenerateSpotWeldConnections)Generate spot welds provided in the Weld input file.[`GetChildren`](#SpotWeldGroup.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#SpotWeldGroup.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#SpotWeldGroup.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#SpotWeldGroup.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#SpotWeldGroup.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#SpotWeldGroup.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#SpotWeldGroup.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`AngleTolerance`](#SpotWeldGroup.AngleTolerance)Gets or sets the AngleTolerance.[`Children`](#SpotWeldGroup.Children)Gets the list of children.[`ChildrenCreationMethod`](#SpotWeldGroup.ChildrenCreationMethod)Gets or sets the ChildrenCreationMethod.[`Comments`](#SpotWeldGroup.Comments)Gets the list of associated comments.[`ConnectionBehavior`](#SpotWeldGroup.ConnectionBehavior)Gets or sets the ConnectionBehavior.[`DataModelObjectCategory`](#SpotWeldGroup.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Images`](#SpotWeldGroup.Images)Gets the list of associated images.[`InternalObject`](#SpotWeldGroup.InternalObject)Gets the internal object. For advanced usage only.[`Material`](#SpotWeldGroup.Material)Gets or sets the Material.[`NumConnections`](#SpotWeldGroup.NumConnections)Gets the NumConnections.[`NumWeldPoints`](#SpotWeldGroup.NumWeldPoints)Gets the NumWeldPoints.[`NumberOfLayers`](#SpotWeldGroup.NumberOfLayers)Gets or sets the NumberOfLayers.[`PenetrationTolerance`](#SpotWeldGroup.PenetrationTolerance)Gets or sets the PenetrationTolerance.[`Properties`](#SpotWeldGroup.Properties)Gets the list of properties for this object.[`ReadOnly`](#SpotWeldGroup.ReadOnly)Gets or sets the ReadOnly.[`ShellThicknessEffect`](#SpotWeldGroup.ShellThicknessEffect)Gets or sets the ShellThicknessEffect.[`SnapToEdgeTolerance`](#SpotWeldGroup.SnapToEdgeTolerance)Gets or sets the SnapToEdgeTolerance.[`SpotWeldFileName`](#SpotWeldGroup.SpotWeldFileName)Gets or sets the SpotWeldFileName.[`StiffnessBehavior`](#SpotWeldGroup.StiffnessBehavior)Gets or sets the StiffnessBehavior.[`Units`](#SpotWeldGroup.Units)Gets or sets the Units.[`VisibleProperties`](#SpotWeldGroup.VisibleProperties)Gets the list of properties that are visible for this object.[`WeldRadius`](#SpotWeldGroup.WeldRadius)Gets or sets the WeldRadius.[`WeldSearchDistance`](#SpotWeldGroup.WeldSearchDistance)Gets or sets the WeldSearchDistance.[`WeldType`](#SpotWeldGroup.WeldType)Gets or sets the WeldType.<a id="property-detail"></a>

## Property detail

<a id="SpotWeldGroup.AngleTolerance"></a>

### *property* SpotWeldGroup.AngleTolerance *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the AngleTolerance.

<a id="SpotWeldGroup.Children"></a>

### *property* SpotWeldGroup.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="SpotWeldGroup.ChildrenCreationMethod"></a>

### *property* SpotWeldGroup.ChildrenCreationMethod *: [Ansys.Mechanical.DataModel.Enums.ConnectionCreationMethod](../../../../Mechanical/DataModel/Enums/ConnectionCreationMethod.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.ConnectionCreationMethod) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ChildrenCreationMethod.

<a id="SpotWeldGroup.Comments"></a>

### *property* SpotWeldGroup.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="SpotWeldGroup.ConnectionBehavior"></a>

### *property* SpotWeldGroup.ConnectionBehavior *: [Ansys.Mechanical.DataModel.Enums.StiffnessBehavior](../../../../Mechanical/DataModel/Enums/StiffnessBehavior.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.StiffnessBehavior) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ConnectionBehavior.

<a id="SpotWeldGroup.DataModelObjectCategory"></a>

### *property* SpotWeldGroup.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="SpotWeldGroup.Images"></a>

### *property* SpotWeldGroup.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="SpotWeldGroup.InternalObject"></a>

### *property* SpotWeldGroup.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSSpotWeldGroupAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="SpotWeldGroup.Material"></a>

### *property* SpotWeldGroup.Material *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Material.

<a id="SpotWeldGroup.NumConnections"></a>

### *property* SpotWeldGroup.NumConnections *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the NumConnections.

<a id="SpotWeldGroup.NumWeldPoints"></a>

### *property* SpotWeldGroup.NumWeldPoints *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the NumWeldPoints.

<a id="SpotWeldGroup.NumberOfLayers"></a>

### *property* SpotWeldGroup.NumberOfLayers *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NumberOfLayers.

<a id="SpotWeldGroup.PenetrationTolerance"></a>

### *property* SpotWeldGroup.PenetrationTolerance *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the PenetrationTolerance.

<a id="SpotWeldGroup.Properties"></a>

### *property* SpotWeldGroup.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="SpotWeldGroup.ReadOnly"></a>

### *property* SpotWeldGroup.ReadOnly *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ReadOnly.

<a id="SpotWeldGroup.ShellThicknessEffect"></a>

### *property* SpotWeldGroup.ShellThicknessEffect *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ShellThicknessEffect.

<a id="SpotWeldGroup.SnapToEdgeTolerance"></a>

### *property* SpotWeldGroup.SnapToEdgeTolerance *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SnapToEdgeTolerance.

<a id="SpotWeldGroup.SpotWeldFileName"></a>

### *property* SpotWeldGroup.SpotWeldFileName *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SpotWeldFileName.

<a id="SpotWeldGroup.StiffnessBehavior"></a>

### *property* SpotWeldGroup.StiffnessBehavior *: [Ansys.Mechanical.DataModel.Enums.StiffnessBehavior](../../../../Mechanical/DataModel/Enums/StiffnessBehavior.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.StiffnessBehavior) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StiffnessBehavior.

<a id="SpotWeldGroup.Units"></a>

### *property* SpotWeldGroup.Units *: [Ansys.Mechanical.DataModel.Enums.WBUnitSystemType](../../../../Mechanical/DataModel/Enums/WBUnitSystemType.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.WBUnitSystemType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Units.

<a id="SpotWeldGroup.VisibleProperties"></a>

### *property* SpotWeldGroup.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="SpotWeldGroup.WeldRadius"></a>

### *property* SpotWeldGroup.WeldRadius *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the WeldRadius.

<a id="SpotWeldGroup.WeldSearchDistance"></a>

### *property* SpotWeldGroup.WeldSearchDistance *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the WeldSearchDistance.

<a id="SpotWeldGroup.WeldType"></a>

### *property* SpotWeldGroup.WeldType *: [Ansys.Mechanical.DataModel.Enums.SpotWeldTypes](../../../../Mechanical/DataModel/Enums/SpotWeldTypes.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.SpotWeldTypes) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the WeldType.

<a id="method-detail"></a>

## Method detail

<a id="SpotWeldGroup.Activate"></a>

### SpotWeldGroup.Activate()

Activate the current object.

<a id="SpotWeldGroup.AddComment"></a>

### SpotWeldGroup.AddComment()

Creates a new child Comment.

<a id="SpotWeldGroup.AddImage"></a>

### SpotWeldGroup.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

```

<a id="SpotWeldGroup.AddSpotWeldConnection"></a>

### SpotWeldGroup.AddSpotWeldConnection()

Creates a new child SpotWeldConnection.

<a id="SpotWeldGroup.CopyTo"></a>

### SpotWeldGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

<a id="SpotWeldGroup.CreateParameter"></a>

### SpotWeldGroup.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="SpotWeldGroup.Duplicate"></a>

### SpotWeldGroup.Duplicate()

Creates a copy of the current DataModelObject.

<a id="SpotWeldGroup.ExportToFile"></a>

### SpotWeldGroup.ExportToFile(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

Exports all spot welds to user selected path.

<a id="SpotWeldGroup.GenerateSpotWeldConnections"></a>

### SpotWeldGroup.GenerateSpotWeldConnections()

Generate spot welds provided in the Weld input file.

<a id="SpotWeldGroup.GetChildren"></a>

### SpotWeldGroup.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="SpotWeldGroup.GetParameter"></a>

### SpotWeldGroup.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="SpotWeldGroup.GroupAllSimilarChildren"></a>

### SpotWeldGroup.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="SpotWeldGroup.GroupSimilarObjects"></a>

### SpotWeldGroup.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="SpotWeldGroup.PropertyByAPIName"></a>

### SpotWeldGroup.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

```

<a id="SpotWeldGroup.PropertyByName"></a>

### SpotWeldGroup.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="SpotWeldGroup.RemoveParameter"></a>

### SpotWeldGroup.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Removes the parameter from the parameter set corresponding to the given property.