Skip to main content

Mechanical scripting interface

ContactStepControl

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.ContactStepControl

Bases: object

Defines a ContactStepControl.

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.
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.
ContactSelection Gets or sets the ContactSelection.
CurrentStep Gets or sets the CurrentStep.
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.
NormalStiffness Gets or sets the NormalStiffness.
NormalStiffnessFactor Gets or sets the NormalStiffnessFactor.
NormalStiffnessValue Gets or sets the NormalStiffnessValue.
Properties Gets the list of properties for this object.
Status Gets or sets the Status.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property ContactStepControl.ContactSelection : Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactSelection.

property ContactStepControl.CurrentStep : int | None

Gets or sets the CurrentStep.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property ContactStepControl.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSElementControlsAuto | None

Gets the internal object. For advanced usage only.

property ContactStepControl.NormalStiffness : Ansys.Mechanical.DataModel.Enums.ElementControlsNormalStiffnessType | None

Gets or sets the NormalStiffness.

property ContactStepControl.NormalStiffnessFactor : float | None

Gets or sets the NormalStiffnessFactor.

property ContactStepControl.NormalStiffnessValue : Ansys.Core.Units.Quantity | None

Gets or sets the NormalStiffnessValue.

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

Gets the list of properties for this object.

property ContactStepControl.Status : Ansys.Mechanical.DataModel.Enums.ElementControlsStatus | None

Gets or sets the Status.

property ContactStepControl.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

ContactStepControl.Activate()

Activate the current object.

ContactStepControl.AddComment()

Creates a new child Comment.

ContactStepControl.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ContactStepControl.CreateParameter(propName: str)

Creates a new parameter for a Property.

ContactStepControl.Delete()

Run the Delete action.

ContactStepControl.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ContactStepControl.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ContactStepControl.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ContactStepControl.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ContactStepControl.PropertyByName(name: str)

Get a property by its unique name.

ContactStepControl.RemoveParameter(propName: str)

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