Skip to main content

Mechanical scripting interface

ContactDataTable

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.ContactDataTable

Bases: object

Defines a ContactDataTable.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
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.
ExportTextFile Run the ExportTextFile 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.

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.
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 ContactDataTable.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property ContactDataTable.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSContactDataTableAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

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

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

Method detail

ContactDataTable.Activate()

Activate the current object.

ContactDataTable.AddComment()

Creates a new child Comment.

ContactDataTable.AddFigure()

Creates a new child Figure.

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

Copies all visible properties from this object to another.

ContactDataTable.CreateParameter(propName: str)

Creates a new parameter for a Property.

ContactDataTable.Delete()

Run the Delete action.

ContactDataTable.Duplicate()

Creates a copy of the current DataModelObject.

ContactDataTable.ExportTextFile(fileName: str)

Run the ExportTextFile action.

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

Gets the list of children, filtered by type.

ContactDataTable.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ContactDataTable.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ContactDataTable.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ContactDataTable.PropertyByName(name: str)

Get a property by its unique name.

ContactDataTable.RemoveParameter(propName: str)

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