MeshWorkflowOutcome

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

Bases: object

Object that wraps IDSEngineeringModelOutcome.

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDomainPatternProperties	GetDomainPatternProperties 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.
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.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnType	Renames applying the default name based on type.
SetPattern	SetPattern method.
SetPropertyValue	SetPropertyValue method.
SetPublish	SetPublish method.
SetUnpublish	SetUnpublish method.
ToString	ToString method.

Properties

CheckpointUnoDataEDXFilePath	Gets or sets the CheckpointUnoDataEDXFilePath.
Children	Gets the list of children.
DataModelObjectCategory	Gets the current DataModelObject's category.
ExternalMethod	Gets or sets the ExternalMethod.
ExternalPattern	Gets or sets the ExternalPattern.
FMFailureCodeID	Gets or sets the FMFailureCodeID.
FMFailureCodeString	Gets or sets the FMFailureCodeString.
FailureInfoInitialized	Gets or sets the FailureInfoInitialized.
FailureMessage	Gets or sets the FailureMessage.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalMethod	Gets or sets the InternalMethod.
InternalObject	Gets the internal object. For advanced usage only.
InternalPattern	Gets or sets the InternalPattern.
LabelEdges	Gets or sets the LabelEdges.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OutcomeString	Gets the OutcomeString.
OutcomeType	Returns the type of the control.
Parent	Parent property.
PerformanceElapsedTime	Gets or sets the PerformanceElapsedTime.
PerformanceFinalProcessMemory	Gets or sets the PerformanceFinalProcessMemory.
PerformancePeakProcessMemory	Gets or sets the PerformancePeakProcessMemory.
PrimeMeshFailureCodeID	Gets or sets the PrimeMeshFailureCodeID.
PrimeMeshFailureCodeString	Gets or sets the PrimeMeshFailureCodeString.
PrimeMeshFailurePart	Gets or sets the PrimeMeshFailurePart.
Properties	Gets the list of properties for this object.
PythonTraceback	Gets or sets the PythonTraceback.
PythonTracebackInitialized	Gets or sets the PythonTracebackInitialized.
ScopeMaterialPointName	Gets or sets the ScopeMaterialPointName.
ScopeMethod	Gets or sets the ScopeMethod.
ScopePattern	Gets or sets the ScopePattern.
SizeFieldName	Gets or sets the SizeFieldName.
State	State property.
Status	Gets the Status.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property MeshWorkflowOutcome.CheckpointUnoDataEDXFilePath: str | None

Gets or sets the CheckpointUnoDataEDXFilePath.

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

Gets the list of children.

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

Gets the current DataModelObject's category.

property MeshWorkflowOutcome.ExternalMethod: str | None

Gets or sets the ExternalMethod.

property MeshWorkflowOutcome.ExternalPattern: str | None

Gets or sets the ExternalPattern.

property MeshWorkflowOutcome.FMFailureCodeID: int | None

Gets or sets the FMFailureCodeID.

property MeshWorkflowOutcome.FMFailureCodeString: str | None

Gets or sets the FMFailureCodeString.

property MeshWorkflowOutcome.FailureInfoInitialized: bool | None

Gets or sets the FailureInfoInitialized.

property MeshWorkflowOutcome.FailureMessage: str | None

Gets or sets the FailureMessage.

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

Gets the list of associated figures.

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

GroupingFolder property.

property MeshWorkflowOutcome.IconName: str | None

IconName property.

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

Gets the list of associated images.

property MeshWorkflowOutcome.InternalMethod: str | None

Gets or sets the InternalMethod.

property MeshWorkflowOutcome.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOutcomeAuto | None

Gets the internal object. For advanced usage only.

property MeshWorkflowOutcome.InternalPattern: str | None

Gets or sets the InternalPattern.

property MeshWorkflowOutcome.LabelEdges: str | None

Gets or sets the LabelEdges.

property MeshWorkflowOutcome.Name: str | None

Name property.

property MeshWorkflowOutcome.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property MeshWorkflowOutcome.OutcomeString: str | None

Gets the OutcomeString.

property MeshWorkflowOutcome.OutcomeType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OutcomeType | None

Returns the type of the control.

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

Parent property.

property MeshWorkflowOutcome.PerformanceElapsedTime: float | None

Gets or sets the PerformanceElapsedTime.

property MeshWorkflowOutcome.PerformanceFinalProcessMemory: float | None

Gets or sets the PerformanceFinalProcessMemory.

property MeshWorkflowOutcome.PerformancePeakProcessMemory: float | None

Gets or sets the PerformancePeakProcessMemory.

property MeshWorkflowOutcome.PrimeMeshFailureCodeID: int | None

Gets or sets the PrimeMeshFailureCodeID.

property MeshWorkflowOutcome.PrimeMeshFailureCodeString: str | None

Gets or sets the PrimeMeshFailureCodeString.

property MeshWorkflowOutcome.PrimeMeshFailurePart: str | None

Gets or sets the PrimeMeshFailurePart.

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

Gets the list of properties for this object.

property MeshWorkflowOutcome.PythonTraceback: str | None

Gets or sets the PythonTraceback.

property MeshWorkflowOutcome.PythonTracebackInitialized: bool | None

Gets or sets the PythonTracebackInitialized.

property MeshWorkflowOutcome.ScopeMaterialPointName: str | None

Gets or sets the ScopeMaterialPointName.

property MeshWorkflowOutcome.ScopeMethod: str | None

Gets or sets the ScopeMethod.

property MeshWorkflowOutcome.ScopePattern: str | None

Gets or sets the ScopePattern.

property MeshWorkflowOutcome.SizeFieldName: str | None

Gets or sets the SizeFieldName.

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

State property.

property MeshWorkflowOutcome.Status: Ansys.Mechanical.DataModel.Enums.MeshWorkflowObjectStatusType | None

Gets the Status.

property MeshWorkflowOutcome.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

MeshWorkflowOutcome.Activate() → None

Activate the current object.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

MeshWorkflowOutcome.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

MeshWorkflowOutcome.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

MeshWorkflowOutcome.GetDomainPatternProperties() → List[System.Collections.Generic.Dictionary[str, Any]]

GetDomainPatternProperties method.

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

Enum name bound to value

MeshWorkflowOutcome.GetHashCode() → int

GetHashCode method.

MeshWorkflowOutcome.GetIconFile() → System.Byte

GetIconFile method.

MeshWorkflowOutcome.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

MeshWorkflowOutcome.GetPath() → str

GetPath method.

MeshWorkflowOutcome.GetPropertyName(dispId: int) → str

GetPropertyName method.

MeshWorkflowOutcome.GetPropertyValue(id: int) → str

GetPropertyValue method.

MeshWorkflowOutcome.GetType() → type

GetType method.

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

GetUnpublishedList method.

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

GetVisibleProperties method.

MeshWorkflowOutcome.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

MeshWorkflowOutcome.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MeshWorkflowOutcome.InitializeLifetimeService() → Any

InitializeLifetimeService method.

MeshWorkflowOutcome.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

MeshWorkflowOutcome.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

MeshWorkflowOutcome.RemoveParameter(propName: str) → None

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

MeshWorkflowOutcome.RenameBasedOnType() → None

Renames applying the default name based on type.

MeshWorkflowOutcome.SetPattern(dispId: int, pattern: str) → None

SetPattern method.

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

SetPropertyValue method.

MeshWorkflowOutcome.SetPublish(id: int) → None

SetPublish method.

MeshWorkflowOutcome.SetUnpublish(id: int) → None

SetUnpublish method.

MeshWorkflowOutcome.ToString() → str

ToString method.