`MeshWorkflowOutput`#

class ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.MeshWorkflowOutput#

Bases: object

Object that wraps IDSEngineeringModelMeshDomainAuto.

Overview#

Methods

`Activate`	Activate the current object.
`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

`Children`	Gets the list of children.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`DataTransferType`	Defines how the PrimeMesh model data should be transferred back into Geometry part(s) and associated mesh(es).
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`LabelsExcludeFilter`	Gets or sets the regular expression to match all labels that are excluded from the transfer. The exclude match removes also labels matching the include pattern. Applies when “TransferLabelsAsNamedSelections” is True.
`LabelsIncludeFilter`	Gets or sets the regular expression to match all labels that are included in the transfer as Named Selections. Applies when “TransferLabelsAsNamedSelections” is True.
`Properties`	Gets the list of properties for this object.
`TransferLabelsAsNamedSelections`	Gets or sets whether to configure the transfer of labels to Mechanical as Named Selections. If set to True, LabelsIncludeFilter must be set to define the whitelist of labels to be transferred, optionally LabelsExcludeFilter can be set to define a blacklist of labels to not be transferred. Only labels matching the LabelsIncludeFilter whitelist and not matching the LabelsExcludeFilter blacklist are transferred. This property is only visible when the DataTransferType is “ByTopology”.
`TransferPrescribedPointsLabelsAsNamedSelections`	Gets or sets whether to configure the transfer of Prescribed Points labels to Mechanical as Named Selections. All labels defined on Prescribed Points will be transferred as criteria based Named Selections scoping the corresponding mesh nodes.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

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

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

property MeshWorkflowOutput.DataTransferType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.DataTransferType | None#: Defines how the PrimeMesh model data should be transferred back into Geometry part(s) and associated mesh(es).

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

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

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

property MeshWorkflowOutput.LabelsExcludeFilter: str | None#: Gets or sets the regular expression to match all labels that are excluded from the transfer. The exclude match removes also labels matching the include pattern. Applies when “TransferLabelsAsNamedSelections” is True.

property MeshWorkflowOutput.LabelsIncludeFilter: str | None#: Gets or sets the regular expression to match all labels that are included in the transfer as Named Selections. Applies when “TransferLabelsAsNamedSelections” is True.

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

property MeshWorkflowOutput.TransferLabelsAsNamedSelections: bool | None#: Gets or sets whether to configure the transfer of labels to Mechanical as Named Selections. If set to True, LabelsIncludeFilter must be set to define the whitelist of labels to be transferred, optionally LabelsExcludeFilter can be set to define a blacklist of labels to not be transferred. Only labels matching the LabelsIncludeFilter whitelist and not matching the LabelsExcludeFilter blacklist are transferred. This property is only visible when the DataTransferType is “ByTopology”.

property MeshWorkflowOutput.TransferPrescribedPointsLabelsAsNamedSelections: bool | None#: Gets or sets whether to configure the transfer of Prescribed Points labels to Mechanical as Named Selections. All labels defined on Prescribed Points will be transferred as criteria based Named Selections scoping the corresponding mesh nodes.

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

Method detail#

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

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

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

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

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

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

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

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

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

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

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

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

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

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