Skip to main content

Mechanical scripting interface

AMBondConnection

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Connections.AMBondConnection

Bases: object

Defines a AMBondConnection.

Overview

Methods

Name Description
Activate Activate the current object.
AddCommandSnippet Creates a new CommandSnippet
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
FlipContactTarget Run the FlipContactTarget action.
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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.
SearchConnectionsForDuplicatePairs Run the SearchConnectionsForDuplicatePairs action.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
ContactBodies Gets the ContactBodies.
ContactType Gets or sets the ContactType.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
SourceLocation Gets or sets the SourceLocation.
Suppressed Gets or sets the Suppressed.
TargetBodies Gets the TargetBodies.
TargetLocation Gets or sets the TargetLocation.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property AMBondConnection.ContactBodies : str | None

Gets the ContactBodies.

property AMBondConnection.ContactType : Ansys.Mechanical.DataModel.Enums.ContactType | None

Gets or sets the ContactType.

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

Gets the current DataModelObject’s category.

property AMBondConnection.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

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

Gets the list of associated images.

property AMBondConnection.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAMBondConnectionAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property AMBondConnection.ReadOnly : bool | None

Gets or sets the ReadOnly.

property AMBondConnection.SourceLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the SourceLocation.

property AMBondConnection.Suppressed : bool | None

Gets or sets the Suppressed.

property AMBondConnection.TargetBodies : str | None

Gets the TargetBodies.

property AMBondConnection.TargetLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the TargetLocation.

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

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

Method detail

AMBondConnection.Activate()

Activate the current object.

AMBondConnection.AddCommandSnippet()

Creates a new CommandSnippet

AMBondConnection.AddComment()

Creates a new child Comment.

AMBondConnection.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

AMBondConnection.CreateParameter(propName: str)

Creates a new parameter for a Property.

AMBondConnection.Delete()

Run the Delete action.

AMBondConnection.Duplicate()

Creates a copy of the current DataModelObject.

AMBondConnection.FlipContactTarget()

Run the FlipContactTarget action.

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

Gets the list of children, filtered by type.

AMBondConnection.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

AMBondConnection.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

AMBondConnection.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

AMBondConnection.PropertyByName(name: str)

Get a property by its unique name.

AMBondConnection.RemoveParameter(propName: str)

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

AMBondConnection.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

AMBondConnection.SearchConnectionsForDuplicatePairs()

Run the SearchConnectionsForDuplicatePairs action.