Coupling
Last update: 14.01.2025
Coupling
class Ansys.ACT.Automation.Mechanical.BoundaryConditions.Coupling
Bases: object
Defines a Coupling.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
AddComment |
Creates a new child Comment. |
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. |
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. |
Properties
Name | Description |
---|---|
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DOFSelection |
Gets or sets the DOFSelection. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
LocalCoordinates |
Gets or sets the LocalCoordinates. |
Location |
Gets or sets the Location. |
Properties |
Gets the list of properties for this object. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property Coupling.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property Coupling.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property Coupling.DOFSelection : Ansys.Mechanical.DataModel.Enums.CouplingConditionDOFType | None
Gets or sets the DOFSelection.
property Coupling.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property Coupling.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property Coupling.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSCouplingConditionAuto | None
Gets the internal object. For advanced usage only.
property Coupling.LocalCoordinates : int | None
Gets or sets the LocalCoordinates.
property Coupling.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property Coupling.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property Coupling.Suppressed : bool | None
Gets or sets the Suppressed.
property Coupling.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
Coupling.Activate()
Activate the current object.
Coupling.AddComment()
Creates a new child Comment.
Coupling.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.
Coupling.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
Coupling.CreateParameter(propName: str)
Creates a new parameter for a Property.
Coupling.Delete()
Run the Delete action.
Coupling.Duplicate()
Creates a copy of the current DataModelObject.
Coupling.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
Coupling.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
Coupling.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
Coupling.GroupSimilarObjects()
Run the GroupSimilarObjects action.
Coupling.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.
Coupling.PropertyByName(name: str)
Get a property by its unique name.
Coupling.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.