MaterialCombination

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

Bases: object

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
AddMaterial	Add a material to the combination.
AddMaterialAssignment	Run the AddMaterialAssignment action.
AddMaterialByName	Add a material to the combination by name.
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.
Delete	Delete the MaterialCombination.
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.
RemoveMaterial	Remove material from the combination.
RemoveMaterialByName	Remove material from the combination by name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AddMaterialToCombination	AddMaterialToCombination property.
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.
Materials	Dictionary of Material to Fraction in Combination.
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	Suppress or unsuppress the MaterialCombination.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property MaterialCombination.AddMaterialToCombination: str | None

AddMaterialToCombination property.

property MaterialCombination.AssignedBodies: int | None

Gets the AssignedBodies.

property MaterialCombination.AttachedRefs: List[int] | None

AttachedRefs property.

property MaterialCombination.CanRemove: bool | None

CanRemove property.

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

Gets the list of children.

property MaterialCombination.ClsId: int | None

ClsId property.

property MaterialCombination.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property MaterialCombination.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

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

GroupingFolder property.

property MaterialCombination.IconName: str | None

IconName property.

property MaterialCombination.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property MaterialCombination.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMaterialCombinationAuto | None

Gets the internal object. For advanced usage only.

property MaterialCombination.MaterialModels: List[Any] | None

Returns a collection of the material models that this material is made up of.

property MaterialCombination.Materials: Ansys.ACT.Automation.Mechanical.MaterialFractionDictionary | None

Dictionary of Material to Fraction in Combination.

property MaterialCombination.Name: str | None

Name property.

property MaterialCombination.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

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

State property.

property MaterialCombination.Suppressed: bool | None

Suppress or unsuppress the MaterialCombination.

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

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

Method detail

MaterialCombination.Activate() → None

Activate the current object.

MaterialCombination.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

MaterialCombination.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

MaterialCombination.AddMaterial(material: Ansys.ACT.Automation.Mechanical.Material) → None

Add a material to the combination.

MaterialCombination.AddMaterialAssignment() → Ansys.ACT.Automation.Mechanical.MaterialAssignment

Run the AddMaterialAssignment action.

MaterialCombination.AddMaterialByName(name: str) → None

Add a material to the combination by name.

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

Copies all visible properties from this object to another.

MaterialCombination.CreateMaterialAssignment() → Ansys.ACT.Automation.Mechanical.MaterialAssignment

Run the CreateMaterialAssignment action.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

MaterialCombination.Delete() → None

Delete the MaterialCombination.

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

Creates a copy of the current DataModelObject.

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

Equals method.

MaterialCombination.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

MaterialCombination.GetAsDictionary() → dict[Any, Any]

Returns material as a python dictionary

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

MaterialCombination.GetEngineeringDataMaterial() → Any

Returns the C# Engineering Data Object that the Material is using internally to keep data

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

Enum name bound to value

MaterialCombination.GetHashCode() → int

GetHashCode method.

MaterialCombination.GetIconFile() → System.Byte

GetIconFile method.

MaterialCombination.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

MaterialCombination.GetPath() → str

GetPath method.

MaterialCombination.GetPropertyName(dispId: int) → str

GetPropertyName method.

MaterialCombination.GetPropertyValue(name: str) → Any

GetPropertyValue method.

MaterialCombination.GetType() → type

GetType method.

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

GetVisibleProperties method.

MaterialCombination.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

MaterialCombination.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MaterialCombination.InitializeLifetimeService() → Any

InitializeLifetimeService method.

MaterialCombination.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

MaterialCombination.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

MaterialCombination.RemoveMaterial(material: Ansys.ACT.Automation.Mechanical.Material) → None

Remove material from the combination.

MaterialCombination.RemoveMaterialByName(name: str) → None

Remove material from the combination by name.

MaterialCombination.RemoveParameter(propName: str) → None

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

MaterialCombination.ToString() → str

ToString method.