`MeshWorkflowStepGroup`

class Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup

Bases: object

Object that wraps IDSEngineeringModelWorkflow.

Overview

Methods

Name	Description
Activate	Activate the current object.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
AddStep	Add another operation to the sequence of steps to be executed for the mesh workflow.
CopyTo	Copies all visible properties from this object to another.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
DeleteAllStepsAndClearGeneratedData	Deletes all steps and reset workflow type to undefined and also resets all inactive geometry parts/bodies to active again, clears the output data, and resets the state of the child objects (“Input”, “Steps”, “Output”) to the initial state. However, any user-defined settings such as the “Input” node scoping are retained.
Duplicate	Creates a copy of the current DataModelObject.
ExecuteAllSteps	Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI).
ExecuteNextStep	Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object.
ExecuteUpToStep	Executes any not yet ready steps up to and including the specified step.
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.
RevertToStep	Revert to the specified step; if no checkpoint is available, then an exception will be raised.

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.
NumberOfCores	Defines how many CPU cores to be used in an operation (if supported by 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 MeshWorkflowStepGroup.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property MeshWorkflowStepGroup.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto | None

Gets the internal object. For advanced usage only.

property MeshWorkflowStepGroup.NumberOfCores : int | None

Defines how many CPU cores to be used in an operation (if supported by the operation).

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

Gets the list of properties for this object.

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

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

Method detail

MeshWorkflowStepGroup.Activate()

Activate the current object.

MeshWorkflowStepGroup.AddFigure()

Creates a new child Figure.

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

MeshWorkflowStepGroup.AddStep(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType)

Add another operation to the sequence of steps to be executed for the mesh workflow.

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

Copies all visible properties from this object to another.

MeshWorkflowStepGroup.CreateParameter(propName: str)

Creates a new parameter for a Property.

MeshWorkflowStepGroup.Delete()

Run the Delete action.

MeshWorkflowStepGroup.DeleteAllStepsAndClearGeneratedData()

Deletes all steps and reset workflow type to undefined and also resets all inactive geometry parts/bodies to active again, clears the output data, and resets the state of the child objects (“Input”, “Steps”, “Output”) to the initial state. However, any user-defined settings such as the “Input” node scoping are retained.

MeshWorkflowStepGroup.Duplicate()

Creates a copy of the current DataModelObject.

MeshWorkflowStepGroup.ExecuteAllSteps()

Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI).

MeshWorkflowStepGroup.ExecuteNextStep()

Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object.

MeshWorkflowStepGroup.ExecuteUpToStep(arg: Any)

Executes any not yet ready steps up to and including the specified step.

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

Gets the list of children, filtered by type.

MeshWorkflowStepGroup.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

MeshWorkflowStepGroup.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

MeshWorkflowStepGroup.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

MeshWorkflowStepGroup.PropertyByName(name: str)

Get a property by its unique name.

MeshWorkflowStepGroup.RemoveParameter(propName: str)

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

MeshWorkflowStepGroup.RevertToStep(arg: Any)

Revert to the specified step; if no checkpoint is available, then an exception will be raised.