`ContactMatch`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.ContactMatch#

Bases: object

Defines a ContactMatch.

Overview#

Methods

`Generate`	Run the Generate action.
`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`InternalObject`	Gets the internal object. For advanced usage only.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`ScopingMethod`	ScopingMethod property.
`ToleranceSlider`	Gets or sets the ToleranceSlider.
`MasterBodies`	Gets the MasterBodies.
`SlaveBodies`	Gets the SlaveBodies.
`SnapTolerance`	Gets or sets the SnapTolerance.
`ScopeMode`	Gets the ScopeMode.
`SnapType`	Gets or sets the SnapType.
`ToleranceType`	Gets or sets the ToleranceType.
`SnapToBoundary`	Gets or sets the SnapToBoundary.
`Suppressed`	Gets or sets the Suppressed.
`MasterLocation`	Gets or sets the MasterLocation.
`SlaveLocation`	Gets or sets the SlaveLocation.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property ContactMatch.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMeshConnectionAuto | None: Gets the internal object. For advanced usage only.

property ContactMatch.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

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

property ContactMatch.ToleranceSlider: System.Int32 | None: Gets or sets the ToleranceSlider.

property ContactMatch.MasterBodies: System.String | None: Gets the MasterBodies.

property ContactMatch.SlaveBodies: System.String | None: Gets the SlaveBodies.

property ContactMatch.SnapTolerance: Ansys.Core.Units.Quantity | None: Gets or sets the SnapTolerance.

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

property ContactMatch.SnapType: Ansys.Mechanical.DataModel.Enums.SnapType | None: Gets or sets the SnapType.

property ContactMatch.ToleranceType: Ansys.Mechanical.DataModel.Enums.ContactToleranceType | None: Gets or sets the ToleranceType.

property ContactMatch.SnapToBoundary: System.Boolean | None: Gets or sets the SnapToBoundary.

property ContactMatch.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property ContactMatch.MasterLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the MasterLocation.

property ContactMatch.SlaveLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the SlaveLocation.

property ContactMatch.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property ContactMatch.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property ContactMatch.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property ContactMatch.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property ContactMatch.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property ContactMatch.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property ContactMatch.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

ContactMatch.Generate() → System.Void: Run the Generate action.

ContactMatch.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

ContactMatch.Delete() → System.Void: Run the Delete action.

ContactMatch.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

ContactMatch.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

ContactMatch.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

ContactMatch.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

ContactMatch.AddImage(filePath: System.String) → 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.

ContactMatch.Activate() → System.Void: Activate the current object.

ContactMatch.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

ContactMatch.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

ContactMatch.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

ContactMatch.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

ContactMatch.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

ContactMatch.PropertyByAPIName(name: System.String) → 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.

ContactMatch.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

ContactMatch.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

ContactMatch.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.