`MeshWorkflowStepGroup`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup#

Bases: object

Object that wraps IDSEngineeringModelWorkflow.

Overview#

Methods

`AddStep`	Add another operation to the sequence of steps to be executed for the mesh workflow.
`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.
`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.
`RevertToStep`	Revert to the specified step; if no checkpoint is available, then an exception will be raised.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`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).
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`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 MeshWorkflowStepGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto | None: Gets the internal object. For advanced usage only.

property MeshWorkflowStepGroup.NumberOfCores: System.Int32 | None: Defines how many CPU cores to be used in an operation (if supported by the operation).

property MeshWorkflowStepGroup.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property MeshWorkflowStepGroup.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property MeshWorkflowStepGroup.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property MeshWorkflowStepGroup.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property MeshWorkflowStepGroup.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property MeshWorkflowStepGroup.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property MeshWorkflowStepGroup.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

MeshWorkflowStepGroup.AddStep(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType) → Ansys.ACT.Automation.Mechanical.MeshWorkflowStep: Add another operation to the sequence of steps to be executed for the mesh workflow.

MeshWorkflowStepGroup.DeleteAllStepsAndClearGeneratedData() → System.Void: 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.ExecuteAllSteps() → System.Void: Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI).

MeshWorkflowStepGroup.ExecuteNextStep() → System.Void: Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object.

MeshWorkflowStepGroup.ExecuteUpToStep(arg: System.Object) → System.Void: Executes any not yet ready steps up to and including the specified step.

MeshWorkflowStepGroup.RevertToStep(arg: System.Object) → System.Void: Revert to the specified step; if no checkpoint is available, then an exception will be raised.

MeshWorkflowStepGroup.Delete() → System.Void: Run the Delete action.

MeshWorkflowStepGroup.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

MeshWorkflowStepGroup.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

MeshWorkflowStepGroup.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

MeshWorkflowStepGroup.AddImage(filePath: System.String) → 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.

MeshWorkflowStepGroup.Activate() → System.Void: Activate the current object.

MeshWorkflowStepGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

MeshWorkflowStepGroup.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

MeshWorkflowStepGroup.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

MeshWorkflowStepGroup.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

MeshWorkflowStepGroup.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

MeshWorkflowStepGroup.PropertyByAPIName(name: System.String) → 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.

MeshWorkflowStepGroup.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

MeshWorkflowStepGroup.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

MeshWorkflowStepGroup.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.