MeshWorkflowOutput

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

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.
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.
GetDetailsView	GetDetailsView method.
GetDomainBrowserAvailableScopes	GetDomainBrowserAvailableScopes 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.
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.
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.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClearCheckpointsDataOnTransfer	Gets or sets whether to clear all checkpoints data upon transfer of the Mesh Workflow mesh to the Mechanical Mesh. The default value is false.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OutputDescription	OutputDescription property.
OutputDescriptionJson	OutputDescriptionJson property.
OutputTypeInformation	OutputTypeInformation property.
OutputTypeInformationJson	OutputTypeInformationJson property.
Parent	Parent property.
ProcessEntityType	Defines how the PrimeMesh model data should be transferred back into Geometry part(s) and associated mesh(es).
Properties	Gets the list of properties for this object.
State	State property.
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”.
TransferOnlyGeometry	Gets or sets whether to transfer only geometry to Mechanical, ignoring mesh elements.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property MeshWorkflowOutput.ClearCheckpointsDataOnTransfer: bool | None

Gets or sets whether to clear all checkpoints data upon transfer of the Mesh Workflow mesh to the Mechanical Mesh. The default value is false.

property MeshWorkflowOutput.ClsId: int | None

ClsId property.

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

GroupingFolder property.

property MeshWorkflowOutput.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property MeshWorkflowOutput.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property MeshWorkflowOutput.OutputDescription: System.Collections.Generic.Dictionary[str, Any] | None

OutputDescription property.

property MeshWorkflowOutput.OutputDescriptionJson: str | None

OutputDescriptionJson property.

property MeshWorkflowOutput.OutputTypeInformation: System.Collections.Generic.Dictionary[str, str] | None

OutputTypeInformation property.

property MeshWorkflowOutput.OutputTypeInformationJson: str | None

OutputTypeInformationJson property.

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

Parent property.

property MeshWorkflowOutput.ProcessEntityType: Ansys.Mechanical.DataModel.Enums.MeshWorkflowProcessEntityType | None

Defines how the PrimeMesh model data should be transferred back into Geometry part(s) and associated mesh(es).

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

Gets the list of properties for this object.

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

State property.

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.TransferOnlyGeometry: bool | None

Gets or sets whether to transfer only geometry to Mechanical, ignoring mesh elements.

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.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

MeshWorkflowOutput.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

GetDomainBrowserAvailableScopes method.

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

Enum name bound to value

MeshWorkflowOutput.GetHashCode() → int

GetHashCode method.

MeshWorkflowOutput.GetIconFile() → System.Byte

GetIconFile method.

MeshWorkflowOutput.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

MeshWorkflowOutput.GetPath() → str

GetPath method.

MeshWorkflowOutput.GetPropertyName(dispId: int) → str

GetPropertyName method.

MeshWorkflowOutput.GetPropertyValue(name: str) → Any

GetPropertyValue method.

MeshWorkflowOutput.GetType() → type

GetType method.

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

GetVisibleProperties method.

MeshWorkflowOutput.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

MeshWorkflowOutput.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MeshWorkflowOutput.InitializeLifetimeService() → Any

InitializeLifetimeService method.

MeshWorkflowOutput.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

MeshWorkflowOutput.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

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

PropertyTypeInfo method.

MeshWorkflowOutput.RemoveParameter(propName: str) → None

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

MeshWorkflowOutput.RenameBasedOnType() → None

Renames applying the default name based on type.

MeshWorkflowOutput.ToString() → str

ToString method.