MeshWorkflowStepGroup

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup(internalObject: Any)

Bases: object

Object that wraps IDSEngineeringModelWorkflow.

Overview

Constructors

GetIMInfoByWorkflow	GetIMInfoByWorkflow method.
GetMeshWorkflowsControlPropertyList	GetMeshWorkflowsControlPropertyList method.
GetMeshWorkflowsOperationPropertyList	GetMeshWorkflowsOperationPropertyList method.
GetMeshWorkflowsOutcomePropertyList	GetMeshWorkflowsOutcomePropertyList method.
GetMeshWorkflowsPropertyList	GetMeshWorkflowsPropertyList method.

Methods

Activate	Activate the current object.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
AddSettings	Add the settings of the input SettingsType to the Steps node.
AddStep	Add another operation to the sequence of steps to be executed for the mesh workflow.
CanCheckPublicStateCallbackForIM	CanCheckPublicStateCallbackForIM method.
CanShowPublishStateIM	CanShowPublishStateIM method.
ConvertWorkflow	Converts the workflow type to Custom
CopyAttachmentPathToClipboard	Copies the current attachment path to clipboard.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
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.
DeleteSettings	Delete the settings of the input SettingsType from the Steps node. All the Settings specific entries are removed automatically to the Steps details.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
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.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDomainBrowserAvailableScopes	GetDomainBrowserAvailableScopes method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetIncrementalMeshingInfo	GetIncrementalMeshingInfo method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetUnpublishedList	GetUnpublishedList method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropagateSettings	Propagate the settings of the input SettingsType to the attributes of the Step nodes. The meshing attributes of the Step nodes will then be automatically defined based on the physical parameters of the settings. Otherwise, the meshing attributes need to be manually specified.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
PublishIMProp	PublishIMProp method.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnType	Renames applying the default name based on type.
RevertToStep	Revert to the specified step; if no checkpoint is available, then an exception will be raised.
SetPropertyValue	SetPropertyValue method.
SetPublish	SetPublish method.
SetUnpublish	SetUnpublish method.
ToString	ToString method.

Properties

AnalysisFrequency	Defines the analysis frequency of the acoustic scenario.
Attachment
Children	Gets the list of children.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
MeshSize	Defines the mesh size of the acoustic scenario based on the wave velocity and the frequency.
Name	Name property.
NumberOfAcousticLayers	Gets the number of layers in the acoustic region. This value is determined based on whether quadratic elements are enabled (see ).
NumberOfCores	Defines how many CPU cores to be used in an operation (if supported by the operation).
NumberOfPMLs	Gets the number of layers in the perfectly meshed layers region. This value is determined based on whether quadratic elements are enabled (see ).
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
QuadraticElements	Defines if the quadratic elements are used for the mesh generation.
SpeedOfSound	Defines the speed of sound in the acoustic scenario.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.
WorkflowString	Gets the WorkflowString.

Property detail

property MeshWorkflowStepGroup.AnalysisFrequency: Ansys.Core.Units.Quantity | None

Defines the analysis frequency of the acoustic scenario.

property MeshWorkflowStepGroup.Attachment: str | None

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property MeshWorkflowStepGroup.IconName: str | None

IconName property.

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.MeshSize: Ansys.Core.Units.Quantity | None

Defines the mesh size of the acoustic scenario based on the wave velocity and the frequency.

property MeshWorkflowStepGroup.Name: str | None

Name property.

property MeshWorkflowStepGroup.NumberOfAcousticLayers: int | None

Gets the number of layers in the acoustic region. This value is determined based on whether quadratic elements are enabled (see ).

property MeshWorkflowStepGroup.NumberOfCores: int | None

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

property MeshWorkflowStepGroup.NumberOfPMLs: int | None

Gets the number of layers in the perfectly meshed layers region. This value is determined based on whether quadratic elements are enabled (see ).

property MeshWorkflowStepGroup.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property MeshWorkflowStepGroup.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property MeshWorkflowStepGroup.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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

Gets the list of properties for this object.

property MeshWorkflowStepGroup.QuadraticElements: bool | None

Defines if the quadratic elements are used for the mesh generation.

property MeshWorkflowStepGroup.SpeedOfSound: Ansys.Core.Units.Quantity | None

Defines the speed of sound in the acoustic scenario.

property MeshWorkflowStepGroup.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property MeshWorkflowStepGroup.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

property MeshWorkflowStepGroup.WorkflowString: str | None

Gets the WorkflowString.

Method detail

MeshWorkflowStepGroup.Activate() → None

Activate the current object.

MeshWorkflowStepGroup.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

MeshWorkflowStepGroup.AddSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) → None

Add the settings of the input SettingsType to the Steps node.

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.CanCheckPublicStateCallbackForIM() → bool

CanCheckPublicStateCallbackForIM method.

MeshWorkflowStepGroup.CanShowPublishStateIM() → bool

CanShowPublishStateIM method.

MeshWorkflowStepGroup.ConvertWorkflow(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType) → None

Converts the workflow type to Custom

MeshWorkflowStepGroup.CopyAttachmentPathToClipboard() → None

Copies the current attachment path to clipboard.

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

Copies all visible properties from this object to another.

MeshWorkflowStepGroup.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

MeshWorkflowStepGroup.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

MeshWorkflowStepGroup.Delete() → None

Run the Delete action.

MeshWorkflowStepGroup.DeleteAllStepsAndClearGeneratedData() → None

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.DeleteSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) → None

Delete the settings of the input SettingsType from the Steps node. All the Settings specific entries are removed automatically to the Steps details.

MeshWorkflowStepGroup.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

MeshWorkflowStepGroup.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

MeshWorkflowStepGroup.ExecuteAllSteps() → None

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

MeshWorkflowStepGroup.ExecuteNextStep() → None

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

MeshWorkflowStepGroup.ExecuteUpToStep(arg: Any) → None

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

MeshWorkflowStepGroup.GetAPIName(dispId: int) → str

Property name bound to dispId.

MeshWorkflowStepGroup.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

MeshWorkflowStepGroup.GetDomainBrowserAvailableScopes() → List[System.Collections.Generic.Dictionary[str, Any]]

GetDomainBrowserAvailableScopes method.

MeshWorkflowStepGroup.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

MeshWorkflowStepGroup.GetHashCode() → int

GetHashCode method.

classmethod MeshWorkflowStepGroup.GetIMInfoByWorkflow(workflow: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto, result: List[System.Collections.Generic.Dictionary[str, Any]]) → None

GetIMInfoByWorkflow method.

MeshWorkflowStepGroup.GetIconFile() → System.Byte

GetIconFile method.

MeshWorkflowStepGroup.GetIncrementalMeshingInfo() → List[System.Collections.Generic.Dictionary[str, Any]]

GetIncrementalMeshingInfo method.

MeshWorkflowStepGroup.GetLifetimeService() → Any

GetLifetimeService method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsControlPropertyList(control: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelControlAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) → None

GetMeshWorkflowsControlPropertyList method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsOperationPropertyList(operation: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOperationAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) → None

GetMeshWorkflowsOperationPropertyList method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsOutcomePropertyList(outcome: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOutcomeAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) → None

GetMeshWorkflowsOutcomePropertyList method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsPropertyList(workflow: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublished: bool, filterPropertyNames: List[str]) → None

GetMeshWorkflowsPropertyList method.

MeshWorkflowStepGroup.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

MeshWorkflowStepGroup.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

MeshWorkflowStepGroup.GetPath() → str

GetPath method.

MeshWorkflowStepGroup.GetPropertyName(dispId: int) → str

GetPropertyName method.

MeshWorkflowStepGroup.GetPropertyValue(id: int) → str

GetPropertyValue method.

MeshWorkflowStepGroup.GetType() → type

GetType method.

MeshWorkflowStepGroup.GetUnpublishedList() → List[System.Collections.Generic.Dictionary[str, Any]]

GetUnpublishedList method.

MeshWorkflowStepGroup.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

MeshWorkflowStepGroup.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

MeshWorkflowStepGroup.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

MeshWorkflowStepGroup.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

MeshWorkflowStepGroup.InitializeLifetimeService() → Any

InitializeLifetimeService method.

MeshWorkflowStepGroup.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

MeshWorkflowStepGroup.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

MeshWorkflowStepGroup.PropagateSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) → None

Propagate the settings of the input SettingsType to the attributes of the Step nodes. The meshing attributes of the Step nodes will then be automatically defined based on the physical parameters of the settings. Otherwise, the meshing attributes need to be manually specified.

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

MeshWorkflowStepGroup.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

MeshWorkflowStepGroup.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

MeshWorkflowStepGroup.PublishIMProp() → None

PublishIMProp method.

MeshWorkflowStepGroup.RemoveParameter(propName: str) → None

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

MeshWorkflowStepGroup.RenameBasedOnType() → None

Renames applying the default name based on type.

MeshWorkflowStepGroup.RevertToStep(arg: Any) → None

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

MeshWorkflowStepGroup.SetPropertyValue(id: int, value: str, validate: int) → None

SetPropertyValue method.

MeshWorkflowStepGroup.SetPublish(id: int) → None

SetPublish method.

MeshWorkflowStepGroup.SetUnpublish(id: int) → None

SetUnpublish method.

MeshWorkflowStepGroup.ToString() → str

ToString method.