ContactMatch

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.ContactMatch(internalObject: Any)

Bases: object

Defines a ContactMatch.

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
Generate	Run the Generate action.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
State	State property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property ContactMatch.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property ContactMatch.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property ContactMatch.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property ContactMatch.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property ContactMatch.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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() → None

Activate the current object.

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

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

Copies all visible properties from this object to another.

ContactMatch.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

ContactMatch.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

ContactMatch.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

ContactMatch.Generate() → None

Run the Generate action.

ContactMatch.GetAPIName(dispId: int) → str

Property name bound to dispId.

ContactMatch.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

ContactMatch.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

ContactMatch.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

ContactMatch.GetHashCode() → int

GetHashCode method.

ContactMatch.GetIconFile() → System.Byte

GetIconFile method.

ContactMatch.GetLifetimeService() → Any

GetLifetimeService method.

ContactMatch.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

ContactMatch.GetPath() → str

GetPath method.

ContactMatch.GetPropertyName(dispId: int) → str

GetPropertyName method.

ContactMatch.GetPropertyValue(name: str) → Any

GetPropertyValue method.

ContactMatch.GetType() → type

GetType method.

ContactMatch.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

ContactMatch.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

ContactMatch.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ContactMatch.InitializeLifetimeService() → Any

InitializeLifetimeService method.

ContactMatch.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

ContactMatch.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

ContactMatch.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

ContactMatch.RemoveParameter(propName: str) → None

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

ContactMatch.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

ContactMatch.ToString() → str

ToString method.