MaterialAssignment

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

Bases: object

Defines a MaterialAssignment.

Overview

Methods

Activate	Activate the current object.
AddCommandSnippet	Creates a new CommandSnippet
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
CopyTo	Copies all visible properties from this object to another.
CreateMaterialPlot	Run the CreateMaterialPlot action.
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.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEngineeringDataMaterial	Returns the C# Engineering Data Object that the MaterialAssignment 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

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
FieldCoordinateSystem	Gets or sets the FieldCoordinateSystem.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Material	Gets or sets the Material.
MaterialName	Gets or sets the MaterialName.
MaterialPolarizationDirection	Gets or sets the MaterialPolarizationDirection.
Name	Name property.
NonlinearEffects	Gets or sets the NonlinearEffects.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
ReferenceTemperatureValue	Gets or sets the ReferenceTemperatureValue.
ScopingMethod	Gets or sets the ScopingMethod.
State	State property.
Suppressed	Gets or sets the Suppressed.
ThermalStrainEffects	Gets or sets the ThermalStrainEffects.
TransferableObjectId	TransferableObjectId property.
UseReferenceTemperatureByBody	Gets or sets the UseReferenceTemperatureByBody.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property MaterialAssignment.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property MaterialAssignment.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property MaterialAssignment.FieldCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the FieldCoordinateSystem.

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

Gets the list of associated figures.

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

GroupingFolder property.

property MaterialAssignment.IconName: str | None

IconName property.

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

Gets the list of associated images.

property MaterialAssignment.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property MaterialAssignment.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMaterialAssignmentAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property MaterialAssignment.Material: str | None

Gets or sets the Material.

property MaterialAssignment.MaterialName: str | None

Gets or sets the MaterialName.

property MaterialAssignment.MaterialPolarizationDirection: Ansys.Mechanical.DataModel.Enums.MaterialPolarizationDirection | None

Gets or sets the MaterialPolarizationDirection.

property MaterialAssignment.Name: str | None

Name property.

property MaterialAssignment.NonlinearEffects: bool | None

Gets or sets the NonlinearEffects.

property MaterialAssignment.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

property MaterialAssignment.ReadOnly: bool | None

Gets or sets the ReadOnly.

property MaterialAssignment.ReferenceTemperatureValue: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceTemperatureValue.

property MaterialAssignment.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

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

State property.

property MaterialAssignment.Suppressed: bool | None

Gets or sets the Suppressed.

property MaterialAssignment.ThermalStrainEffects: bool | None

Gets or sets the ThermalStrainEffects.

property MaterialAssignment.TransferableObjectId: str | None

TransferableObjectId property.

property MaterialAssignment.UseReferenceTemperatureByBody: bool | None

Gets or sets the UseReferenceTemperatureByBody.

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

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

Method detail

MaterialAssignment.Activate() → None

Activate the current object.

MaterialAssignment.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

MaterialAssignment.CreateMaterialPlot() → Ansys.ACT.Automation.Mechanical.MaterialPlot

Run the CreateMaterialPlot action.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

MaterialAssignment.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

MaterialAssignment.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

MaterialAssignment.GetEngineeringDataMaterial() → Any

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

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

Enum name bound to value

MaterialAssignment.GetHashCode() → int

GetHashCode method.

MaterialAssignment.GetIconFile() → System.Byte

GetIconFile method.

MaterialAssignment.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

MaterialAssignment.GetPath() → str

GetPath method.

MaterialAssignment.GetPropertyName(dispId: int) → str

GetPropertyName method.

MaterialAssignment.GetPropertyValue(name: str) → Any

GetPropertyValue method.

MaterialAssignment.GetType() → type

GetType method.

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

GetVisibleProperties method.

MaterialAssignment.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

MaterialAssignment.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MaterialAssignment.InitializeLifetimeService() → Any

InitializeLifetimeService method.

MaterialAssignment.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

MaterialAssignment.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

MaterialAssignment.RemoveParameter(propName: str) → None

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

MaterialAssignment.ToString() → str

ToString method.