MaterialPlot

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

Bases: object

Defines a MaterialPlot.

Overview

Methods

Activate	Activate the current object.
Clear	Run the Clear action.
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.
Generate	Run the Generate action.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView 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.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property MaterialPlot.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property MaterialPlot.ClsId: int | None

ClsId property.

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

Gets the current DataModelObject's category.

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

GroupingFolder property.

property MaterialPlot.IconName: str | None

IconName property.

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

Name property.

property MaterialPlot.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

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

State property.

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() → None

Activate the current object.

MaterialPlot.Clear() → None

Run the Clear action.

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

MaterialPlot.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

MaterialPlot.Generate() → None

Run the Generate action.

MaterialPlot.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

MaterialPlot.GetHashCode() → int

GetHashCode method.

MaterialPlot.GetIconFile() → System.Byte

GetIconFile method.

MaterialPlot.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

MaterialPlot.GetPath() → str

GetPath method.

MaterialPlot.GetPropertyName(dispId: int) → str

GetPropertyName method.

MaterialPlot.GetPropertyValue(name: str) → Any

GetPropertyValue method.

MaterialPlot.GetType() → type

GetType method.

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

GetVisibleProperties method.

MaterialPlot.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

MaterialPlot.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MaterialPlot.InitializeLifetimeService() → Any

InitializeLifetimeService method.

MaterialPlot.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

MaterialPlot.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

MaterialPlot.RemoveParameter(propName: str) → None

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

MaterialPlot.ToString() → str

ToString method.