MeshWorkflowStep

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.MeshWorkflowStep(internalObject: Any)

Bases: object

Object that wraps IDSEngineeringModelGeometryOperationAuto.

Overview

Methods

Activate	Activate the current object.
AddControl	Adds a MeshWorkflowControl node as child node of the “Step” tree node. This control node can be created under any step node. This node is created to set properties that are required for executing an operation.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
AddOutcome	Adds a MeshWorkflowOutcome node as child node of the “Step” tree node. This outcome node can be created under any step node. This node is created to see the results after executing an operation.
CanCompleteInteractiveSession	Query if this operation can complete an interactive mesh edit session.
CanRevertStep	CanRevertStep method.
CanStartInteractiveSession	Query if this operation can start an interactive mesh edit session.
CanSuppressWorkflowOperation	Checks if the workflow step can be suppressed.
CanUnsuppressWorkflowOperation	Checks if the workflow step can be unsuppressed.
ClearDataAndDisableCheckpoint	Clear checkpoint data and disable checkpointing for the step.
CompleteInteractiveSession	Query if this operation can complete an interactive mesh edit session.
CopyTo	Copies all visible properties from this object to another.
CreateMeshEditMorphControl	Create a mesh edit morph control from the morph operation.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
DuplicateOperation	Duplicates the workflow
DuplicateOperationAfter	Duplicates the workflow
DuplicateOperationBefore	Duplicates the workflow
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetApplicableControlTypes	GetApplicableControlTypes method.
GetApplicableOutcomeTypes	GetApplicableOutcomeTypes method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetDomainBrowserAvailableMorphFieldPatterns	GetDomainBrowserAvailableMorphFieldPatterns method.
GetDomainBrowserAvailableScopes	GetDomainBrowserAvailableScopes method.
GetDomainBrowserAvailableSizeFieldPatterns	GetDomainBrowserAvailableSizeFieldPatterns method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile 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.
GetPropertyWorksheetInfo	GetPropertyWorksheetInfo 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.
InsertStepAfter	Creates a new MeshWorkflowStep
InsertStepBefore	Creates a new MeshWorkflowStep
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
MeshWorkflowControls	Gets the MeshWorkflowControls of an MeshWorkflowStep.
MeshWorkflowOutcomes	Gets the MeshWorkflowOutcomes of an MeshWorkflowStep.
Preview	Preview the MeshWorkflowStep. After the preview, the step will contain a preview outcome with the information required for the validation of the user inputs. The preview outcome can be returned using the MeshWorkflowOutcomes method of the step.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
PropertyTypeInfo	PropertyTypeInfo method.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnType	Renames applying the default name based on type.
SuppressWorkflowOperation	Suppresses the workflow step to exclude it from execution.
ToString	ToString method.
UnsuppressWorkflowOperation	Unsuppresses the workflow step to include it in execution.

Properties

AttachedRefs	AttachedRefs property.
CanEdit	Gets whether the step can be edited or not.
Children	Gets the list of children.
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
EnableCheckpoint	Gets or sets whether the checkpointing is enabled for the step.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OperationString	Gets the OperationString.
OperationType	Returns the type of the operation. .
Parent	Parent property.
Position	The step's position in the workflow ordered steps.
Properties	Gets the list of properties for this object.
ReleaseStatusString	ReleaseStatusString property.
State	State property.
StepDescription	StepDescription property.
StepDescriptionJson	StepDescriptionJson property.
StepTypeInformation	StepTypeInformation property.
StepTypeInformationJson	StepTypeInformationJson property.
Suppressed	Gets or sets the Suppressed.
ValidateMeshStatus	Gets or sets whether the mesh validation is enabled for the step.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property MeshWorkflowStep.AttachedRefs: List[int] | None

AttachedRefs property.

property MeshWorkflowStep.CanEdit: bool | None

Gets whether the step can be edited or not.

property MeshWorkflowStep.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property MeshWorkflowStep.ClsId: int | None

ClsId property.

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

Gets the current DataModelObject's category.

property MeshWorkflowStep.EnableCheckpoint: bool | None

Gets or sets whether the checkpointing is enabled for the step.

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

Gets the list of associated figures.

property MeshWorkflowStep.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property MeshWorkflowStep.IconName: str | None

IconName property.

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

Gets the list of associated images.

property MeshWorkflowStep.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOperationAuto | None

Gets the internal object. For advanced usage only.

property MeshWorkflowStep.Name: str | None

Name property.

property MeshWorkflowStep.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property MeshWorkflowStep.OperationString: str | None

Gets the OperationString.

property MeshWorkflowStep.OperationType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType | None

Returns the type of the operation. .

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

Parent property.

property MeshWorkflowStep.Position: int | None

The step's position in the workflow ordered steps.

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

Gets the list of properties for this object.

property MeshWorkflowStep.ReleaseStatusString: str | None

ReleaseStatusString property.

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

State property.

property MeshWorkflowStep.StepDescription: System.Collections.Generic.Dictionary[str, Any] | None

StepDescription property.

property MeshWorkflowStep.StepDescriptionJson: str | None

StepDescriptionJson property.

property MeshWorkflowStep.StepTypeInformation: System.Collections.Generic.Dictionary[str, str] | None

StepTypeInformation property.

property MeshWorkflowStep.StepTypeInformationJson: str | None

StepTypeInformationJson property.

property MeshWorkflowStep.Suppressed: bool | None

Gets or sets the Suppressed.

property MeshWorkflowStep.ValidateMeshStatus: bool | None

Gets or sets whether the mesh validation is enabled for the step.

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

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

Method detail

MeshWorkflowStep.Activate() → None

Activate the current object.

MeshWorkflowStep.AddControl(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlType) → Ansys.ACT.Automation.Mechanical.MeshWorkflowControl

Adds a MeshWorkflowControl node as child node of the “Step” tree node. This control node can be created under any step node. This node is created to set properties that are required for executing an operation.

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

Creates a new child Figure.

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

MeshWorkflowStep.AddOutcome(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OutcomeType) → Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome

Adds a MeshWorkflowOutcome node as child node of the “Step” tree node. This outcome node can be created under any step node. This node is created to see the results after executing an operation.

MeshWorkflowStep.CanCompleteInteractiveSession() → bool

Query if this operation can complete an interactive mesh edit session.

MeshWorkflowStep.CanRevertStep() → bool

CanRevertStep method.

MeshWorkflowStep.CanStartInteractiveSession() → bool

Query if this operation can start an interactive mesh edit session.

MeshWorkflowStep.CanSuppressWorkflowOperation() → bool

Checks if the workflow step can be suppressed.

MeshWorkflowStep.CanUnsuppressWorkflowOperation() → bool

Checks if the workflow step can be unsuppressed.

MeshWorkflowStep.ClearDataAndDisableCheckpoint() → None

Clear checkpoint data and disable checkpointing for the step.

MeshWorkflowStep.CompleteInteractiveSession(succeeded: bool) → None

Query if this operation can complete an interactive mesh edit session.

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

Copies all visible properties from this object to another.

MeshWorkflowStep.CreateMeshEditMorphControl() → Ansys.ACT.Automation.Mechanical.DirectMorph

Create a mesh edit morph control from the morph operation.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

MeshWorkflowStep.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

MeshWorkflowStep.DuplicateOperation() → Ansys.ACT.Automation.Mechanical.MeshWorkflowStep

Duplicates the workflow

MeshWorkflowStep.DuplicateOperationAfter() → Ansys.ACT.Automation.Mechanical.MeshWorkflowStep

Duplicates the workflow

MeshWorkflowStep.DuplicateOperationBefore() → Ansys.ACT.Automation.Mechanical.MeshWorkflowStep

Duplicates the workflow

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

Equals method.

MeshWorkflowStep.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

MeshWorkflowStep.GetApplicableControlTypes() → List[Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlType]

GetApplicableControlTypes method.

MeshWorkflowStep.GetApplicableOutcomeTypes() → List[Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OutcomeType]

GetApplicableOutcomeTypes method.

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

Gets the list of children, filtered by type.

MeshWorkflowStep.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

MeshWorkflowStep.GetDomainBrowserAvailableMorphFieldPatterns(path: str) → List[System.Collections.Generic.Dictionary[str, Any]]

GetDomainBrowserAvailableMorphFieldPatterns method.

MeshWorkflowStep.GetDomainBrowserAvailableScopes(path: str) → List[System.Collections.Generic.Dictionary[str, Any]]

GetDomainBrowserAvailableScopes method.

MeshWorkflowStep.GetDomainBrowserAvailableSizeFieldPatterns(path: str) → List[System.Collections.Generic.Dictionary[str, Any]]

GetDomainBrowserAvailableSizeFieldPatterns method.

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

Enum name bound to value

MeshWorkflowStep.GetHashCode() → int

GetHashCode method.

MeshWorkflowStep.GetIconFile() → System.Byte

GetIconFile method.

MeshWorkflowStep.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

MeshWorkflowStep.GetPath() → str

GetPath method.

MeshWorkflowStep.GetPropertyName(dispId: int) → str

GetPropertyName method.

MeshWorkflowStep.GetPropertyValue(name: str) → Any

GetPropertyValue method.

MeshWorkflowStep.GetPropertyWorksheetInfo() → List[System.Collections.Generic.Dictionary[str, Any]]

GetPropertyWorksheetInfo method.

MeshWorkflowStep.GetType() → type

GetType method.

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

GetUnpublishedList method.

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

GetVisibleProperties method.

MeshWorkflowStep.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

MeshWorkflowStep.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MeshWorkflowStep.InitializeLifetimeService() → Any

InitializeLifetimeService method.

MeshWorkflowStep.InsertStepAfter(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType, createMandatoryControls: bool) → Ansys.ACT.Automation.Mechanical.MeshWorkflowStep

Creates a new MeshWorkflowStep

MeshWorkflowStep.InsertStepBefore(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType, createMandatoryControls: bool) → Ansys.ACT.Automation.Mechanical.MeshWorkflowStep

Creates a new MeshWorkflowStep

MeshWorkflowStep.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

MeshWorkflowStep.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

MeshWorkflowStep.MeshWorkflowControls(bIgnoreSuppressed: bool, filterByType: str) → List[Ansys.ACT.Automation.Mechanical.MeshWorkflowControl]

Gets the MeshWorkflowControls of an MeshWorkflowStep.

MeshWorkflowStep.MeshWorkflowOutcomes(bIgnoreSuppressed: bool) → List[Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome]

Gets the MeshWorkflowOutcomes of an MeshWorkflowStep.

MeshWorkflowStep.Preview() → None

Preview the MeshWorkflowStep. After the preview, the step will contain a preview outcome with the information required for the validation of the user inputs. The preview outcome can be returned using the MeshWorkflowOutcomes method of the step.

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

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

PropertyById method.

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

Get a property by its unique name.

MeshWorkflowStep.PropertyTypeInfo(property: Ansys.ACT.Automation.Mechanical.Property) → System.Collections.Generic.Dictionary[str, Any]

PropertyTypeInfo method.

MeshWorkflowStep.RemoveParameter(propName: str) → None

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

MeshWorkflowStep.RenameBasedOnType() → None

Renames applying the default name based on type.

MeshWorkflowStep.SuppressWorkflowOperation() → None

Suppresses the workflow step to exclude it from execution.

MeshWorkflowStep.ToString() → str

ToString method.

MeshWorkflowStep.UnsuppressWorkflowOperation() → None

Unsuppresses the workflow step to include it in execution.