SpotWeldConnection

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Connections.SpotWeldConnection(internalObject: Any)

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.
AttachToEvents	AttachToEvents method.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
CreateSpotWeldFromHitPoint	Add a new spot weld by using a Hit Point.
DetachEvents	DetachEvents method.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
ExportToCSVFile	Export the contents to a CSV file.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetCurrentItemsInWorksheet	GetCurrentItemsInWorksheet method.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetSpotWeldIds	GetSpotWeldIds method.
GetSpotWeldLocations	GetSpotWeldLocations method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
NotifyOnHitPointAdded	NotifyOnHitPointAdded method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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.
SetCurrentItemsInWorksheet	SetCurrentItemsInWorksheet method.
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.
ToString	ToString method.
UnitSys	UnitSys method.
add_OnHitPointAdded	add_OnHitPointAdded method.
add_OnPointPicked	add_OnPointPicked method.
remove_OnHitPointAdded	remove_OnHitPointAdded method.
remove_OnPointPicked	remove_OnPointPicked method.
setXYZ	setXYZ method.

Properties

AngleTolerance	Gets or sets the AngleTolerance.
AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
ConnectionBehavior	Gets or sets the ConnectionBehavior.
DataModelObjectCategory	Gets the current DataModelObject's category.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Material	Gets or sets the Material.
Name	Name property.
NumWeldPoints	Gets the NumWeldPoints.
NumberOfLayers	Gets or sets the NumberOfLayers.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
State	State property.
StiffnessBehavior	Gets or sets the StiffnessBehavior.
TargetGeometry	Gets or sets the TargetGeometry.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property SpotWeldConnection.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property SpotWeldConnection.IconName: str | None

IconName property.

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

Gets the list of associated images.

property SpotWeldConnection.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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.Name: str | None

Name property.

property SpotWeldConnection.NumWeldPoints: int | None

Gets the NumWeldPoints.

property SpotWeldConnection.NumberOfLayers: int | None

Gets or sets the NumberOfLayers.

property SpotWeldConnection.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property SpotWeldConnection.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property SpotWeldConnection.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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.TransferableObjectId: str | None

TransferableObjectId property.

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.AttachToEvents() → None

AttachToEvents method.

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

Copies all visible properties from this object to another.

SpotWeldConnection.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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.DetachEvents() → None

DetachEvents method.

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

Creates a copy of the current DataModelObject.

SpotWeldConnection.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

SpotWeldConnection.ExportToCSVFile(fileName: str) → None

Export the contents to a CSV file.

SpotWeldConnection.GetAPIName(dispId: int) → str

Property name bound to dispId.

SpotWeldConnection.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

SpotWeldConnection.GetCurrentItemsInWorksheet() → tuple[int]

GetCurrentItemsInWorksheet method.

SpotWeldConnection.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

SpotWeldConnection.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

SpotWeldConnection.GetHashCode() → int

GetHashCode method.

SpotWeldConnection.GetIconFile() → System.Byte

GetIconFile method.

SpotWeldConnection.GetLifetimeService() → Any

GetLifetimeService method.

SpotWeldConnection.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

SpotWeldConnection.GetPath() → str

GetPath method.

SpotWeldConnection.GetPropertyName(dispId: int) → str

GetPropertyName method.

SpotWeldConnection.GetPropertyValue(name: str) → Any

GetPropertyValue method.

SpotWeldConnection.GetSpotWeldIds() → tuple[int]

GetSpotWeldIds method.

SpotWeldConnection.GetSpotWeldLocations() → tuple[float]

GetSpotWeldLocations method.

SpotWeldConnection.GetType() → type

GetType method.

SpotWeldConnection.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

SpotWeldConnection.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

SpotWeldConnection.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

SpotWeldConnection.InitializeLifetimeService() → Any

InitializeLifetimeService method.

SpotWeldConnection.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

SpotWeldConnection.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

SpotWeldConnection.NotifyOnHitPointAdded(x: float, y: float, z: float) → None

NotifyOnHitPointAdded method.

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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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.SetCurrentItemsInWorksheet(spotWeldIds: List[int]) → None

SetCurrentItemsInWorksheet method.

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.

SpotWeldConnection.ToString() → str

ToString method.

SpotWeldConnection.UnitSys() → str

UnitSys method.

SpotWeldConnection.add_OnHitPointAdded(value: System.EventHandler[Ansys.ACT.Automation.Mechanical.Connections.SpotWeldConnectionChangedArgs]) → None

add_OnHitPointAdded method.

SpotWeldConnection.add_OnPointPicked(value: System.EventHandler) → None

add_OnPointPicked method.

SpotWeldConnection.remove_OnHitPointAdded(value: System.EventHandler[Ansys.ACT.Automation.Mechanical.Connections.SpotWeldConnectionChangedArgs]) → None

remove_OnHitPointAdded method.

SpotWeldConnection.remove_OnPointPicked(value: System.EventHandler) → None

remove_OnPointPicked method.

SpotWeldConnection.setXYZ(spotWeldId: int, point: Ansys.Mechanical.Graphics.Point) → None

setXYZ method.