Mechanical scripting interface 2025

`MatchControl`

Last update: 16.07.2025

class Ansys.ACT.Automation.Mechanical.MeshControls.MatchControl

Bases: object

Defines a MatchControl.

Overview

Methods

Name Description
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

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
ControlMessages Gets the ControlMessages.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
HighCoordinateSystem Gets or sets the HighCoordinateSystem.
HighGeometrySelection Gets or sets the HighGeometrySelection.
HighNamedSelection Gets or sets the HighNamedSelection.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LowCoordinateSystem Gets or sets the LowCoordinateSystem.
LowGeometrySelection Gets or sets the LowGeometrySelection.
LowNamedSelection Gets or sets the LowNamedSelection.
Properties Gets the list of properties for this object.
RotationAxis Gets or sets the RotationAxis.
ScopingMethod Gets or sets the ScopingMethod.
Suppressed Gets or sets the Suppressed.
Transformation Gets or sets the Transformation.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property MatchControl.ControlMessages : bool | None

Gets the ControlMessages.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property MatchControl.HighCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the HighCoordinateSystem.

property MatchControl.HighGeometrySelection : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the HighGeometrySelection.

property MatchControl.HighNamedSelection : Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the HighNamedSelection.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property MatchControl.LowCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the LowCoordinateSystem.

property MatchControl.LowGeometrySelection : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the LowGeometrySelection.

property MatchControl.LowNamedSelection : Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the LowNamedSelection.

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

Gets the list of properties for this object.

property MatchControl.RotationAxis : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the RotationAxis.

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

Gets or sets the ScopingMethod.

property MatchControl.Suppressed : bool | None

Gets or sets the Suppressed.

property MatchControl.Transformation : int | None

Gets or sets the Transformation.

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

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

Method detail

MatchControl.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

MatchControl.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

MatchControl.GenerateMesh() → None

Generate the Mesh.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

MatchControl.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

MatchControl.RemoveParameter(propName: str) → None

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

MatchControl.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

Connect with Ansys