AMBondConnection

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

Bases: object

Defines a AMBondConnection.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
FlipContactTarget	Run the FlipContactTarget action.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties 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.
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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
SearchConnectionsForDuplicatePairs	Run the SearchConnectionsForDuplicatePairs action.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
SourceLocation	Gets or sets the SourceLocation.
State	State property.
Suppressed	Gets or sets the Suppressed.
TargetBodies	Gets the TargetBodies.
TargetLocation	Gets or sets the TargetLocation.
TransferableObjectId	TransferableObjectId property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property AMBondConnection.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property AMBondConnection.ClsId: int | None

ClsId property.

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

GroupingFolder property.

property AMBondConnection.IconName: str | None

IconName property.

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

Gets the list of associated images.

property AMBondConnection.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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

Gets the internal object. For advanced usage only.

property AMBondConnection.Name: str | None

Name property.

property AMBondConnection.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

State property.

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

TransferableObjectId property.

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

Activate the current object.

AMBondConnection.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

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

Creates a new child Comment.

AMBondConnection.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

AMBondConnection.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

AMBondConnection.FlipContactTarget() → None

Run the FlipContactTarget action.

AMBondConnection.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

AMBondConnection.GetHashCode() → int

GetHashCode method.

AMBondConnection.GetIconFile() → System.Byte

GetIconFile method.

AMBondConnection.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

AMBondConnection.GetPath() → str

GetPath method.

AMBondConnection.GetPropertyName(dispId: int) → str

GetPropertyName method.

AMBondConnection.GetPropertyValue(name: str) → Any

GetPropertyValue method.

AMBondConnection.GetType() → type

GetType method.

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

GetVisibleProperties method.

AMBondConnection.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

AMBondConnection.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

AMBondConnection.InitializeLifetimeService() → Any

InitializeLifetimeService method.

AMBondConnection.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

AMBondConnection.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

AMBondConnection.RemoveParameter(propName: str) → None

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

AMBondConnection.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

AMBondConnection.SearchConnectionsForDuplicatePairs() → None

Run the SearchConnectionsForDuplicatePairs action.

AMBondConnection.ToString() → str

ToString method.