SpotWeldGroup

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

Bases: object

Defines a SpotWeldGroup.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
ExportToFile	Exports all spot welds to user selected path.
GenerateSpotWeldConnections	Generate spot welds provided in the Weld input file.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetAllSpotWeldIds	GetAllSpotWeldIds method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLargestSpotWeldID	GetLargestSpotWeldID 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.
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.
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.
SetLargestSpotWeldID	SetLargestSpotWeldID method.
ToString	ToString method.

Properties

AngleTolerance	Gets or sets the AngleTolerance.
AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ChildrenCreationMethod	Gets or sets the ChildrenCreationMethod.
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.
NumConnections	Gets the NumConnections.
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.
ReadOnly	Gets or sets the ReadOnly.
ShellThicknessEffect	Gets or sets the ShellThicknessEffect.
SnapToEdgeTolerance	Gets or sets the SnapToEdgeTolerance.
SpotWeldFileName	Gets or sets the SpotWeldFileName.
State	State property.
StiffnessBehavior	Gets or sets the StiffnessBehavior.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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.ClsId: int | None

ClsId property.

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

GroupingFolder property.

property SpotWeldGroup.IconName: str | None

IconName property.

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

Gets the list of associated images.

property SpotWeldGroup.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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

Name property.

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.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

State property.

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

Gets or sets the StiffnessBehavior.

property SpotWeldGroup.TransferableObjectId: str | None

TransferableObjectId property.

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

Activate the current object.

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

Creates a new child Comment.

SpotWeldGroup.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.

SpotWeldGroup.AddSpotWeldConnection() → Ansys.ACT.Automation.Mechanical.Connections.SpotWeldConnection

Creates a new child SpotWeldConnection.

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

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

Creates a copy of the current DataModelObject.

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

Equals method.

SpotWeldGroup.ExportToFile(filePath: str) → None

Exports all spot welds to user selected path.

SpotWeldGroup.GenerateSpotWeldConnections() → None

Generate spot welds provided in the Weld input file.

SpotWeldGroup.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

SpotWeldGroup.GetAllSpotWeldIds() → List[int]

GetAllSpotWeldIds method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

SpotWeldGroup.GetHashCode() → int

GetHashCode method.

SpotWeldGroup.GetIconFile() → System.Byte

GetIconFile method.

SpotWeldGroup.GetLargestSpotWeldID() → int

GetLargestSpotWeldID method.

SpotWeldGroup.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

SpotWeldGroup.GetPath() → str

GetPath method.

SpotWeldGroup.GetPropertyName(dispId: int) → str

GetPropertyName method.

SpotWeldGroup.GetPropertyValue(name: str) → Any

GetPropertyValue method.

SpotWeldGroup.GetType() → type

GetType method.

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

GetVisibleProperties method.

SpotWeldGroup.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

SpotWeldGroup.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

SpotWeldGroup.InitializeLifetimeService() → Any

InitializeLifetimeService method.

SpotWeldGroup.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

SpotWeldGroup.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

SpotWeldGroup.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.

SpotWeldGroup.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

SpotWeldGroup.RemoveParameter(propName: str) → None

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

SpotWeldGroup.SetLargestSpotWeldID(largestId: int) → None

SetLargestSpotWeldID method.

SpotWeldGroup.ToString() → str

ToString method.