`Material`#

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

Bases: object

Defines a Material.

Overview#

Constructors

GetMaterialAsDictionary

Returns material as a python dictionary

Methods

`Activate`	Activate the current object.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`AddMaterialAssignment`	Run the AddMaterialAssignment action.
`CopyTo`	Copies all visible properties from this object to another.
`CreateMaterialAssignment`	Run the CreateMaterialAssignment action.
`CreateObjRef`	CreateObjRef method.
`CreateParameter`	Creates a new parameter for a Property.
`Duplicate`	Creates a copy of the current DataModelObject.
`Equals`	Equals method.
`GetAPIName`	Property name bound to dispId.
`GetAllProperties`	GetAllProperties method.
`GetAsDictionary`	Returns material as a python dictionary
`GetChildren`	Gets the list of children, filtered by type.
`GetDetailsView`	GetDetailsView method.
`GetEngineeringDataMaterial`	Returns the C# Engineering Data Object that the Material is using internally to keep data
`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

`AssignedBodies`	Gets the AssignedBodies.
`AttachedRefs`	AttachedRefs property.
`CanRemove`	CanRemove property.
`Children`	Gets the list of children.
`ClsId`	ClsId property.
`Comments`	Gets the list of associated comments.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`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.
`MaterialModels`	Returns a collection of the material models that this material is made up of.
`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.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property Material.AssignedBodies: int | None#: Gets the AssignedBodies.

property Material.AttachedRefs: List[int] | None#: AttachedRefs property.

property Material.CanRemove: bool | None#: CanRemove property.

property Material.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property Material.ClsId: int | None#: ClsId property.

property Material.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property Material.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property Material.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property Material.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: GroupingFolder property.

property Material.IconName: str | None#: IconName property.

property Material.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property Material.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMaterialAuto | None#: Gets the internal object. For advanced usage only.

property Material.MaterialModels: List[Any] | None#: Returns a collection of the material models that this material is made up of.

property Material.Name: str | None#: Name property.

property Material.ObjectId: int | None#: ObjectId property.

property Material.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#: ObjectState property.

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

property Material.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: Parent property.

property Material.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property Material.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#: State property.

property Material.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

Method detail#

Material.Activate() → None#: Activate the current object.

Material.AddComment() → Ansys.ACT.Automation.Mechanical.Comment#: Creates a new child Comment.

Material.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure#: Creates a new child Figure.

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

Material.AddMaterialAssignment() → Ansys.ACT.Automation.Mechanical.MaterialAssignment#: Run the AddMaterialAssignment action.

Material.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

Material.CreateMaterialAssignment() → Ansys.ACT.Automation.Mechanical.MaterialAssignment#: Run the CreateMaterialAssignment action.

Material.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef#: CreateObjRef method.

Material.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

Material.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#: Creates a copy of the current DataModelObject.

Material.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool#: Equals method.

Material.GetAPIName(dispId: int) → str#: Property name bound to dispId.

Material.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#: GetAllProperties method.

Material.GetAsDictionary() → dict[Any, Any]#: Returns material as a python dictionary

Material.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

Material.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData#: GetDetailsView method.

Material.GetEngineeringDataMaterial() → Any#: Returns the C# Engineering Data Object that the Material is using internally to keep data

Material.GetEnumName(enumType: type, value: int, dispId: int) → str#: Enum name bound to value

Material.GetHashCode() → int#: GetHashCode method.

Material.GetIconFile() → System.Byte#: GetIconFile method.

Material.GetLifetimeService() → Any#: GetLifetimeService method.

classmethod Material.GetMaterialAsDictionary(edaMaterial: Any) → dict[Any, Any]#: Returns material as a python dictionary

Material.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None#: GetObjectData method.

Material.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

Material.GetPath() → str#: GetPath method.

Material.GetPropertyName(dispId: int) → str#: GetPropertyName method.

Material.GetPropertyValue(name: str) → Any#: GetPropertyValue method.

Material.GetType() → type#: GetType method.

Material.GetVisibleProperties() → List[System.Reflection.PropertyInfo]#: GetVisibleProperties method.

Material.GetVisiblePropertyNames() → List[str]#: GetVisiblePropertyNames method.

Material.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

Material.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#: Run the GroupSimilarObjects action.

Material.InitializeLifetimeService() → Any#: InitializeLifetimeService method.

Material.IsPropertyEditable(dispId: int) → bool#: IsPropertyEditable method.

Material.IsPropertyVisible(dispId: int) → bool#: IsPropertyVisible method.

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

Material.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property#: PropertyById method.

Material.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

Material.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

Material.ToString() → str#: ToString method.

Material#

Overview#

Property detail#

Method detail#

`Material`#