class Ansys.ACT.Automation.Mechanical.MaterialPlot

Bases: object

Defines a MaterialPlot.

Overview

Methods

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

Properties

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

Property detail

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

Gets the list of children.

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

Gets the current DataModelObject’s category.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property MaterialPlot.MaterialProperty : str | None

Gets or sets the MaterialProperty.

property MaterialPlot.MaterialPropertyComponent : str | None

Gets or sets the MaterialPropertyComponent.

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

Gets the list of properties for this object.

property MaterialPlot.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

MaterialPlot.Activate()

Activate the current object.

MaterialPlot.Clear()

Run the Clear action.

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

Copies all visible properties from this object to another.

MaterialPlot.CreateParameter(propName: str)

Creates a new parameter for a Property.

MaterialPlot.Delete()

Run the Delete action.

MaterialPlot.Duplicate()

Creates a copy of the current DataModelObject.

MaterialPlot.Generate()

Run the Generate action.

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

Gets the list of children, filtered by type.

MaterialPlot.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

MaterialPlot.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

MaterialPlot.GroupSimilarObjects()

Run the GroupSimilarObjects action.

MaterialPlot.PropertyByAPIName(name: str)

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.PropertyByName(name: str)

Get a property by its unique name.

MaterialPlot.RemoveParameter(propName: str)

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