MaterialPlot

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.MaterialPlot

Bases: object

Defines a MaterialPlot.

Overview

Methods

Clear	Run the Clear action.
Generate	Run the Generate action.
Delete	Run the Delete action.
GetChildren	Gets the list of children, filtered by type.
GetChildren	Gets the list of children, filtered by type.
Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
Duplicate	Creates a copy of the current DataModelObject.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
PropertyByName	Get a property by its unique name.
PropertyByAPIName	Get a property by its API name.
CreateParameter	Creates a new parameter for a Property.
GetParameter	Gets the parameter corresponding to the given property.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.

Properties

InternalObject	Gets the internal object. For advanced usage only.
MaterialPropertyComponent	Gets or sets the MaterialPropertyComponent.
MaterialProperty	Gets or sets the MaterialProperty.
Suppressed	Gets or sets the Suppressed.
Location	Gets or sets the Location.
DataModelObjectCategory	Gets the current DataModelObject’s category.
Children	Gets the list of children.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property MaterialPlot.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMaterialPlotAuto | None

Gets the internal object. For advanced usage only.

property MaterialPlot.MaterialPropertyComponent: System.String | None

Gets or sets the MaterialPropertyComponent.

property MaterialPlot.MaterialProperty: System.String | None

Gets or sets the MaterialProperty.

property MaterialPlot.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property MaterialPlot.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

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

Gets the current DataModelObject’s category.

property MaterialPlot.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property MaterialPlot.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property MaterialPlot.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property MaterialPlot.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

MaterialPlot.Clear() → System.Void

Run the Clear action.

MaterialPlot.Generate() → System.Void

Run the Generate action.

MaterialPlot.Delete() → System.Void

Run the Delete action.

MaterialPlot.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

MaterialPlot.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Gets the list of children, filtered by type.

MaterialPlot.Activate() → System.Void

Activate the current object.

MaterialPlot.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

MaterialPlot.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MaterialPlot.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

MaterialPlot.PropertyByAPIName(name: System.String) → 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.

MaterialPlot.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

MaterialPlot.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

MaterialPlot.RemoveParameter(propName: System.String) → System.Void

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