`MeshWorkflowGroup`#

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

Bases: object

Defines a MeshWorkflowGroup.

Overview#

Methods

`Activate`	Activate the current object.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`AddMeshWorkflow`	Adds a new workflow to the “MeshWorkflowGroup” object.
`ClearGeneratedData`	Resets all mesh workflows completely, i.e. also the geometry scoping transferred into each mesh workflow will be reset and all inactive geometry parts/bodies will become active again. Steps, controls, and outcomes will be reset to their initial state while any user-defined property settings will remain as-is.
`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.
`GenerateWorkflows`	Generates all mesh workflows, i.e. executes the “Input”, the “Steps”, and the “Output” as needed.
`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

`ActiveWorkflow`	Gets the ActiveWorkflow.
`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.
`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 MeshWorkflowGroup.ActiveWorkflow: Ansys.ACT.Automation.Mechanical.MeshWorkflow | None#: Gets the ActiveWorkflow.

property MeshWorkflowGroup.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property MeshWorkflowGroup.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property MeshWorkflowGroup.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property MeshWorkflowGroup.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property MeshWorkflowGroup.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property MeshWorkflowGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelAuto | None#: Gets the internal object. For advanced usage only.

property MeshWorkflowGroup.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property MeshWorkflowGroup.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

Method detail#

MeshWorkflowGroup.Activate() → None#: Activate the current object.

MeshWorkflowGroup.AddComment() → Ansys.ACT.Automation.Mechanical.Comment#: Creates a new child Comment.

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

MeshWorkflowGroup.AddImage(filePath: str) → 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.

MeshWorkflowGroup.AddMeshWorkflow(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType) → Ansys.ACT.Automation.Mechanical.MeshWorkflow#: Adds a new workflow to the “MeshWorkflowGroup” object.

MeshWorkflowGroup.ClearGeneratedData() → None#: Resets all mesh workflows completely, i.e. also the geometry scoping transferred into each mesh workflow will be reset and all inactive geometry parts/bodies will become active again. Steps, controls, and outcomes will be reset to their initial state while any user-defined property settings will remain as-is.

MeshWorkflowGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

MeshWorkflowGroup.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

MeshWorkflowGroup.Delete() → None#: Run the Delete action.

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

MeshWorkflowGroup.GenerateWorkflows() → None#: Generates all mesh workflows, i.e. executes the “Input”, the “Steps”, and the “Output” as needed.

MeshWorkflowGroup.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

MeshWorkflowGroup.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

MeshWorkflowGroup.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

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

MeshWorkflowGroup.PropertyByAPIName(name: str) → 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.

MeshWorkflowGroup.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

MeshWorkflowGroup.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.