`SpotWeldConnection`#

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

Bases: object

Defines a SpotWeldConnection.

Overview#

Methods

`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.
`AddNewSpotWeld`	Add a new spot weld with/without a customID.
`RemoveSpotWeld`	Remove an existing spot weld.
`ExportToCSVFile`	Export the contents to a CSV file.
`CreateSpotWeldFromHitPoint`	Add a new spot weld by using a Hit Point.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`InternalObject`	Gets the internal object. For advanced usage only.
`Material`	Gets or sets the Material.
`NumberOfLayers`	Gets or sets the NumberOfLayers.
`NumWeldPoints`	Gets the NumWeldPoints.
`AngleTolerance`	Gets or sets the AngleTolerance.
`PenetrationTolerance`	Gets or sets the PenetrationTolerance.
`Radius`	Gets or sets the Radius.
`SnapToEdgeTolerance`	Gets or sets the SnapToEdgeTolerance.
`SearchDistance`	Gets or sets the SearchDistance.
`ConnectionBehavior`	Gets or sets the ConnectionBehavior.
`Type`	Gets or sets the Type.
`StiffnessBehavior`	Gets or sets the StiffnessBehavior.
`ShellThicknessEffect`	Gets or sets the ShellThicknessEffect.
`SourceGeometry`	Gets or sets the SourceGeometry.
`TargetGeometry`	Gets or sets the TargetGeometry.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property SpotWeldConnection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSpotWeldConnectionAuto | None: Gets the internal object. For advanced usage only.

property SpotWeldConnection.Material: System.String | None: Gets or sets the Material.

property SpotWeldConnection.NumberOfLayers: System.Int32 | None: Gets or sets the NumberOfLayers.

property SpotWeldConnection.NumWeldPoints: System.Int32 | None: Gets the NumWeldPoints.

property SpotWeldConnection.AngleTolerance: Ansys.Core.Units.Quantity | None: Gets or sets the AngleTolerance.

property SpotWeldConnection.PenetrationTolerance: Ansys.Core.Units.Quantity | None: Gets or sets the PenetrationTolerance.

property SpotWeldConnection.Radius: Ansys.Core.Units.Quantity | None: Gets or sets the Radius.

property SpotWeldConnection.SnapToEdgeTolerance: Ansys.Core.Units.Quantity | None: Gets or sets the SnapToEdgeTolerance.

property SpotWeldConnection.SearchDistance: Ansys.Core.Units.Quantity | None: Gets or sets the SearchDistance.

property SpotWeldConnection.ConnectionBehavior: Ansys.Mechanical.DataModel.Enums.StiffnessBehavior | None: Gets or sets the ConnectionBehavior.

property SpotWeldConnection.Type: Ansys.Mechanical.DataModel.Enums.SpotWeldTypes | None: Gets or sets the Type.

property SpotWeldConnection.StiffnessBehavior: Ansys.Mechanical.DataModel.Enums.StiffnessBehavior | None: Gets or sets the StiffnessBehavior.

property SpotWeldConnection.ShellThicknessEffect: System.Boolean | None: Gets or sets the ShellThicknessEffect.

property SpotWeldConnection.SourceGeometry: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the SourceGeometry.

property SpotWeldConnection.TargetGeometry: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the TargetGeometry.

property SpotWeldConnection.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property SpotWeldConnection.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property SpotWeldConnection.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property SpotWeldConnection.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property SpotWeldConnection.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property SpotWeldConnection.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property SpotWeldConnection.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property SpotWeldConnection.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

SpotWeldConnection.SetXCoordinate(spotWeldId: System.Int32, val: Ansys.Core.Units.Quantity) → System.Void: Set the X coordinate given the Spot Weld ID.

SpotWeldConnection.SetYCoordinate(spotWeldId: System.Int32, val: Ansys.Core.Units.Quantity) → System.Void: Set the Y coordinate given the Spot Weld ID.

SpotWeldConnection.SetZCoordinate(spotWeldId: System.Int32, val: Ansys.Core.Units.Quantity) → System.Void: Set the Z coordinate given the Spot Weld ID.

SpotWeldConnection.AddNewSpotWeld(customId: System.Int32) → System.Void: Add a new spot weld with/without a customID.

SpotWeldConnection.RemoveSpotWeld(spotWeldId: System.Int32) → System.Void: Remove an existing spot weld.

SpotWeldConnection.ExportToCSVFile(fileName: System.String) → System.Void: Export the contents to a CSV file.

SpotWeldConnection.CreateSpotWeldFromHitPoint() → System.Void: Add a new spot weld by using a Hit Point.

SpotWeldConnection.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

SpotWeldConnection.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

SpotWeldConnection.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

SpotWeldConnection.AddImage(filePath: System.String) → 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.Activate() → System.Void: Activate the current object.

SpotWeldConnection.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

SpotWeldConnection.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

SpotWeldConnection.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

SpotWeldConnection.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

SpotWeldConnection.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

SpotWeldConnection.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

SpotWeldConnection.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

SpotWeldConnection.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.