Skip to main content

Mechanical scripting interface

MeshWorkflowStep

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.MeshWorkflowStep

Bases: object

Object that wraps IDSEngineeringModelGeometryOperationAuto.

Overview

Methods

Name Description
Activate Activate the current object.
AddControl Adds a MeshWorkflowControl node as child node of the “Step” tree node. This control node can be created under any step node. This node is created to set properties that are required for executing an operation.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
AddOutcome Adds a MeshWorkflowOutcome node as child node of the “Step” tree node. This outcome node can be created under any step node. This node is created to see the results after executing an operation.
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.
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.
OperationType Returns the type of the operation. .
Properties Gets the list of properties for this object.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property MeshWorkflowStep.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOperationAuto | None

Gets the internal object. For advanced usage only.

property MeshWorkflowStep.OperationType : Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType | None

Returns the type of the operation. .

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

Gets the list of properties for this object.

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

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

Method detail

MeshWorkflowStep.Activate()

Activate the current object.

MeshWorkflowStep.AddControl(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlType)

Adds a MeshWorkflowControl node as child node of the “Step” tree node. This control node can be created under any step node. This node is created to set properties that are required for executing an operation.

MeshWorkflowStep.AddFigure()

Creates a new child Figure.

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

MeshWorkflowStep.AddOutcome(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OutcomeType)

Adds a MeshWorkflowOutcome node as child node of the “Step” tree node. This outcome node can be created under any step node. This node is created to see the results after executing an operation.

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

Copies all visible properties from this object to another.

MeshWorkflowStep.CreateParameter(propName: str)

Creates a new parameter for a Property.

MeshWorkflowStep.Delete()

Run the Delete action.

MeshWorkflowStep.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

MeshWorkflowStep.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

MeshWorkflowStep.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

MeshWorkflowStep.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

MeshWorkflowStep.PropertyByName(name: str)

Get a property by its unique name.

MeshWorkflowStep.RemoveParameter(propName: str)

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