Connect

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MeshControls.Connect

Bases: object

Defines a Connect.

Overview

Methods

Activate	Activate the current object.
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.
GenerateMesh	Generate the Mesh.
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.

Properties

Children	Gets the list of children.
Comments	Gets the list of associated comments.
ConnectionOption	Gets or sets the ConnectionOption.
ConnectionSize	Gets or sets the ConnectionSize.
ConnectionTolerance	Gets or sets the ConnectionTolerance.
ConnectionToleranceList	Gets or sets the ConnectionToleranceList.
CoplanarAngleTolerance	Gets or sets the CoplanarAngleTolerance.
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.
Location	Gets or sets the Location.
MultipleConnectionStep	Gets or sets the MultipleConnectionStep.
NamedSelection	Gets or sets the NamedSelection.
PerformIntersections	Gets or sets the PerformIntersections.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property Connect.ConnectionOption: Ansys.Mechanical.DataModel.Enums.ConnectionOptions | None

Gets or sets the ConnectionOption.

property Connect.ConnectionSize: Ansys.Core.Units.Quantity | None

Gets or sets the ConnectionSize.

property Connect.ConnectionTolerance: Ansys.Core.Units.Quantity | None

Gets or sets the ConnectionTolerance.

property Connect.ConnectionToleranceList: str | None

Gets or sets the ConnectionToleranceList.

property Connect.CoplanarAngleTolerance: Ansys.Core.Units.Quantity | None

Gets or sets the CoplanarAngleTolerance.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property Connect.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMeshControlAuto | None

Gets the internal object. For advanced usage only.

property Connect.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property Connect.MultipleConnectionStep: bool | None

Gets or sets the MultipleConnectionStep.

property Connect.NamedSelection: Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the NamedSelection.

property Connect.PerformIntersections: bool | None

Gets or sets the PerformIntersections.

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

Gets the list of properties for this object.

property Connect.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property Connect.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

Connect.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

Connect.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

Connect.GenerateMesh() → None

Generate the Mesh.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

Connect.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

Connect.RemoveParameter(propName: str) → None

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

Connect.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.