Skip to main content

Mechanical scripting interface

ContactMatch

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ContactMatch

Bases: object

Defines a ContactMatch.

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.
Generate Run the Generate 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.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
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.
MasterBodies Gets the MasterBodies.
MasterLocation Gets or sets the MasterLocation.
Properties Gets the list of properties for this object.
ScopeMode Gets the ScopeMode.
ScopingMethod ScopingMethod property.
SlaveBodies Gets the SlaveBodies.
SlaveLocation Gets or sets the SlaveLocation.
SnapToBoundary Gets or sets the SnapToBoundary.
SnapTolerance Gets or sets the SnapTolerance.
SnapType Gets or sets the SnapType.
Suppressed Gets or sets the Suppressed.
ToleranceSlider Gets or sets the ToleranceSlider.
ToleranceType Gets or sets the ToleranceType.
ToleranceValue Gets or sets the ToleranceValue.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property ContactMatch.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSMeshConnectionAuto | None

Gets the internal object. For advanced usage only.

property ContactMatch.MasterBodies : str | None

Gets the MasterBodies.

property ContactMatch.MasterLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the MasterLocation.

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

Gets the list of properties for this object.

property ContactMatch.ScopeMode : Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None

Gets the ScopeMode.

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

ScopingMethod property.

property ContactMatch.SlaveBodies : str | None

Gets the SlaveBodies.

property ContactMatch.SlaveLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the SlaveLocation.

property ContactMatch.SnapToBoundary : bool | None

Gets or sets the SnapToBoundary.

property ContactMatch.SnapTolerance : Ansys.Core.Units.Quantity | None

Gets or sets the SnapTolerance.

property ContactMatch.SnapType : Ansys.Mechanical.DataModel.Enums.SnapType | None

Gets or sets the SnapType.

property ContactMatch.Suppressed : bool | None

Gets or sets the Suppressed.

property ContactMatch.ToleranceSlider : int | None

Gets or sets the ToleranceSlider.

property ContactMatch.ToleranceType : Ansys.Mechanical.DataModel.Enums.ContactToleranceType | None

Gets or sets the ToleranceType.

property ContactMatch.ToleranceValue : Ansys.Core.Units.Quantity | None

Gets or sets the ToleranceValue.

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

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

Method detail

ContactMatch.Activate()

Activate the current object.

ContactMatch.AddComment()

Creates a new child Comment.

ContactMatch.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ContactMatch.CreateParameter(propName: str)

Creates a new parameter for a Property.

ContactMatch.Delete()

Run the Delete action.

ContactMatch.Duplicate()

Creates a copy of the current DataModelObject.

ContactMatch.Generate()

Run the Generate action.

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

Gets the list of children, filtered by type.

ContactMatch.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ContactMatch.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ContactMatch.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ContactMatch.PropertyByName(name: str)

Get a property by its unique name.

ContactMatch.RemoveParameter(propName: str)

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

ContactMatch.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.