Skip to main content

Mechanical scripting interface

SpotWeldGroup

Last update: 14.01.2025

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

Bases: object

Defines a SpotWeldGroup.

Overview

Methods

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

Properties

Name Description
AngleTolerance Gets or sets the AngleTolerance.
Children Gets the list of children.
ChildrenCreationMethod Gets or sets the ChildrenCreationMethod.
Comments Gets the list of associated comments.
ConnectionBehavior Gets or sets the ConnectionBehavior.
DataModelObjectCategory Gets the current DataModelObject’s category.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Material Gets or sets the Material.
NumConnections Gets the NumConnections.
NumWeldPoints Gets the NumWeldPoints.
NumberOfLayers Gets or sets the NumberOfLayers.
PenetrationTolerance Gets or sets the PenetrationTolerance.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ShellThicknessEffect Gets or sets the ShellThicknessEffect.
SnapToEdgeTolerance Gets or sets the SnapToEdgeTolerance.
SpotWeldFileName Gets or sets the SpotWeldFileName.
StiffnessBehavior Gets or sets the StiffnessBehavior.
Units Gets or sets the Units.
VisibleProperties Gets the list of properties that are visible for this object.
WeldRadius Gets or sets the WeldRadius.
WeldSearchDistance Gets or sets the WeldSearchDistance.
WeldType Gets or sets the WeldType.

Property detail

property SpotWeldGroup.AngleTolerance : Ansys.Core.Units.Quantity | None

Gets or sets the AngleTolerance.

property SpotWeldGroup.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property SpotWeldGroup.ChildrenCreationMethod : Ansys.Mechanical.DataModel.Enums.ConnectionCreationMethod | None

Gets or sets the ChildrenCreationMethod.

property SpotWeldGroup.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property SpotWeldGroup.ConnectionBehavior : Ansys.Mechanical.DataModel.Enums.StiffnessBehavior | None

Gets or sets the ConnectionBehavior.

property SpotWeldGroup.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property SpotWeldGroup.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property SpotWeldGroup.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSSpotWeldGroupAuto | None

Gets the internal object. For advanced usage only.

property SpotWeldGroup.Material : str | None

Gets or sets the Material.

property SpotWeldGroup.NumConnections : int | None

Gets the NumConnections.

property SpotWeldGroup.NumWeldPoints : int | None

Gets the NumWeldPoints.

property SpotWeldGroup.NumberOfLayers : int | None

Gets or sets the NumberOfLayers.

property SpotWeldGroup.PenetrationTolerance : Ansys.Core.Units.Quantity | None

Gets or sets the PenetrationTolerance.

property SpotWeldGroup.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property SpotWeldGroup.ReadOnly : bool | None

Gets or sets the ReadOnly.

property SpotWeldGroup.ShellThicknessEffect : bool | None

Gets or sets the ShellThicknessEffect.

property SpotWeldGroup.SnapToEdgeTolerance : Ansys.Core.Units.Quantity | None

Gets or sets the SnapToEdgeTolerance.

property SpotWeldGroup.SpotWeldFileName : str | None

Gets or sets the SpotWeldFileName.

property SpotWeldGroup.StiffnessBehavior : Ansys.Mechanical.DataModel.Enums.StiffnessBehavior | None

Gets or sets the StiffnessBehavior.

property SpotWeldGroup.Units : Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None

Gets or sets the Units.

property SpotWeldGroup.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

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

property SpotWeldGroup.WeldRadius : Ansys.Core.Units.Quantity | None

Gets or sets the WeldRadius.

property SpotWeldGroup.WeldSearchDistance : Ansys.Core.Units.Quantity | None

Gets or sets the WeldSearchDistance.

property SpotWeldGroup.WeldType : Ansys.Mechanical.DataModel.Enums.SpotWeldTypes | None

Gets or sets the WeldType.

Method detail

SpotWeldGroup.Activate()

Activate the current object.

SpotWeldGroup.AddComment()

Creates a new child Comment.

SpotWeldGroup.AddImage(filePath: str)

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.

SpotWeldGroup.AddSpotWeldConnection()

Creates a new child SpotWeldConnection.

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

Copies all visible properties from this object to another.

SpotWeldGroup.CreateParameter(propName: str)

Creates a new parameter for a Property.

SpotWeldGroup.Duplicate()

Creates a copy of the current DataModelObject.

SpotWeldGroup.ExportToFile(filePath: str)

Exports all spot welds to user selected path.

SpotWeldGroup.GenerateSpotWeldConnections()

Generate spot welds provided in the Weld input file.

SpotWeldGroup.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

SpotWeldGroup.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

SpotWeldGroup.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

SpotWeldGroup.GroupSimilarObjects()

Run the GroupSimilarObjects action.

SpotWeldGroup.PropertyByAPIName(name: str)

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.

SpotWeldGroup.PropertyByName(name: str)

Get a property by its unique name.

SpotWeldGroup.RemoveParameter(propName: str)

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