SpotWeldConnection

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Connections.SpotWeldConnection

Bases: object

Defines a SpotWeldConnection.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddImage	Creates a new child Image.
AddNewSpotWeld	Add a new spot weld with/without a customID.
CopyTo	Copies all visible properties from this object to another.
CreateParameter	Creates a new parameter for a Property.
CreateSpotWeldFromHitPoint	Add a new spot weld by using a Hit Point.
Duplicate	Creates a copy of the current DataModelObject.
ExportToCSVFile	Export the contents to a CSV 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.
RemoveSpotWeld	Remove an existing spot weld.
SetXCoordinate	Set the X coordinate given the Spot Weld ID.
SetYCoordinate	Set the Y coordinate given the Spot Weld ID.
SetZCoordinate	Set the Z coordinate given the Spot Weld ID.

Properties

AngleTolerance	Gets or sets the AngleTolerance.
Children	Gets the list of children.
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.
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.
Radius	Gets or sets the Radius.
ReadOnly	Gets or sets the ReadOnly.
SearchDistance	Gets or sets the SearchDistance.
ShellThicknessEffect	Gets or sets the ShellThicknessEffect.
SnapToEdgeTolerance	Gets or sets the SnapToEdgeTolerance.
SourceGeometry	Gets or sets the SourceGeometry.
StiffnessBehavior	Gets or sets the StiffnessBehavior.
TargetGeometry	Gets or sets the TargetGeometry.
Type	Gets or sets the Type.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets or sets the AngleTolerance.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ConnectionBehavior.

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

Gets the current DataModelObject's category.

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

Gets the list of associated images.

property SpotWeldConnection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSpotWeldConnectionAuto | None

Gets the internal object. For advanced usage only.

property SpotWeldConnection.Material: str | None

Gets or sets the Material.

property SpotWeldConnection.NumWeldPoints: int | None

Gets the NumWeldPoints.

property SpotWeldConnection.NumberOfLayers: int | None

Gets or sets the NumberOfLayers.

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

Gets or sets the PenetrationTolerance.

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

Gets the list of properties for this object.

property SpotWeldConnection.Radius: Ansys.Core.Units.Quantity | None

Gets or sets the Radius.

property SpotWeldConnection.ReadOnly: bool | None

Gets or sets the ReadOnly.

property SpotWeldConnection.SearchDistance: Ansys.Core.Units.Quantity | None

Gets or sets the SearchDistance.

property SpotWeldConnection.ShellThicknessEffect: bool | None

Gets or sets the ShellThicknessEffect.

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

Gets or sets the SnapToEdgeTolerance.

property SpotWeldConnection.SourceGeometry: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the SourceGeometry.

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

Gets or sets the StiffnessBehavior.

property SpotWeldConnection.TargetGeometry: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the TargetGeometry.

property SpotWeldConnection.Type: Ansys.Mechanical.DataModel.Enums.SpotWeldTypes | None

Gets or sets the Type.

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

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

Method detail

SpotWeldConnection.Activate() → None

Activate the current object.

SpotWeldConnection.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

SpotWeldConnection.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

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.

SpotWeldConnection.AddNewSpotWeld(customId: int) → None

Add a new spot weld with/without a customID.

SpotWeldConnection.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

SpotWeldConnection.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

SpotWeldConnection.CreateSpotWeldFromHitPoint() → None

Add a new spot weld by using a Hit Point.

SpotWeldConnection.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

SpotWeldConnection.ExportToCSVFile(fileName: str) → None

Export the contents to a CSV file.

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

Gets the list of children, filtered by type.

SpotWeldConnection.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

SpotWeldConnection.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

SpotWeldConnection.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

SpotWeldConnection.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

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.

SpotWeldConnection.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

SpotWeldConnection.RemoveParameter(propName: str) → None

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

SpotWeldConnection.RemoveSpotWeld(spotWeldId: int) → None

Remove an existing spot weld.

SpotWeldConnection.SetXCoordinate(spotWeldId: int, val: Ansys.Core.Units.Quantity) → None

Set the X coordinate given the Spot Weld ID.

SpotWeldConnection.SetYCoordinate(spotWeldId: int, val: Ansys.Core.Units.Quantity) → None

Set the Y coordinate given the Spot Weld ID.

SpotWeldConnection.SetZCoordinate(spotWeldId: int, val: Ansys.Core.Units.Quantity) → None

Set the Z coordinate given the Spot Weld ID.