Skip to main content

Mechanical scripting interface

GeneratedAMSupport

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.GeneratedAMSupport

Bases: object

Defines a GeneratedAMSupport.

Overview

Methods

Name Description
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.
ClearGeneratedData Run the ClearGeneratedData action.
CopyTo Copies all visible properties from this object to another.
CreateNamedSelectionOfGeneratedElements Run the PromoteToNamedSelection action.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GenerateSupportBodies Generate Support Bodies.
GetChildren Gets the list of children, filtered by type.
GetGeneratedBody Returns the generated body object
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.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
DensityMultiple Gets or sets the DensityMultiple.
ElasticModulusMultipleInX Gets or sets the ElasticModulusMultipleInX.
ElasticModulusMultipleInY Gets or sets the ElasticModulusMultipleInY.
ElasticModulusMultipleInZ Gets or sets the ElasticModulusMultipleInZ.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
MaterialMultiplier Gets or sets the MaterialMultiplier.
Mode Gets or sets the Mode.
MultiplierEntry Gets or sets the MultiplierEntry.
Properties Gets the list of properties for this object.
ShearModulusMultipleInXY Gets or sets the ShearModulusMultipleInXY.
ShearModulusMultipleInXZ Gets or sets the ShearModulusMultipleInXZ.
ShearModulusMultipleInYZ Gets or sets the ShearModulusMultipleInYZ.
SupportType Gets or sets the SupportType.
ThermalConductivityMultipleInX Gets or sets the ThermalConductivityMultipleInX.
ThermalConductivityMultipleInY Gets or sets the ThermalConductivityMultipleInY.
ThermalConductivityMultipleInZ Gets or sets the ThermalConductivityMultipleInZ.
VisibleProperties Gets the list of properties that are visible for this object.
Volume Gets or sets the Volume.
WallSpacing Gets or sets the WallSpacing.
WallThickness Gets or sets the WallThickness.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

property GeneratedAMSupport.DensityMultiple : float | None

Gets or sets the DensityMultiple.

property GeneratedAMSupport.ElasticModulusMultipleInX : float | None

Gets or sets the ElasticModulusMultipleInX.

property GeneratedAMSupport.ElasticModulusMultipleInY : float | None

Gets or sets the ElasticModulusMultipleInY.

property GeneratedAMSupport.ElasticModulusMultipleInZ : float | None

Gets or sets the ElasticModulusMultipleInZ.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property GeneratedAMSupport.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAMSupportAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property GeneratedAMSupport.MaterialMultiplier : float | None

Gets or sets the MaterialMultiplier.

property GeneratedAMSupport.Mode : Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None

Gets or sets the Mode.

property GeneratedAMSupport.MultiplierEntry : Ansys.Mechanical.DataModel.Enums.AMMultiplierEntryType | None

Gets or sets the MultiplierEntry.

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

Gets the list of properties for this object.

property GeneratedAMSupport.ShearModulusMultipleInXY : float | None

Gets or sets the ShearModulusMultipleInXY.

property GeneratedAMSupport.ShearModulusMultipleInXZ : float | None

Gets or sets the ShearModulusMultipleInXZ.

property GeneratedAMSupport.ShearModulusMultipleInYZ : float | None

Gets or sets the ShearModulusMultipleInYZ.

property GeneratedAMSupport.SupportType : Ansys.Mechanical.DataModel.Enums.AMSupportType | None

Gets or sets the SupportType.

property GeneratedAMSupport.ThermalConductivityMultipleInX : float | None

Gets or sets the ThermalConductivityMultipleInX.

property GeneratedAMSupport.ThermalConductivityMultipleInY : float | None

Gets or sets the ThermalConductivityMultipleInY.

property GeneratedAMSupport.ThermalConductivityMultipleInZ : float | None

Gets or sets the ThermalConductivityMultipleInZ.

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

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

property GeneratedAMSupport.Volume : Ansys.Core.Units.Quantity | None

Gets or sets the Volume.

property GeneratedAMSupport.WallSpacing : Ansys.Core.Units.Quantity | None

Gets or sets the WallSpacing.

property GeneratedAMSupport.WallThickness : Ansys.Core.Units.Quantity | None

Gets or sets the WallThickness.

Method detail

GeneratedAMSupport.Activate()

Activate the current object.

GeneratedAMSupport.AddCommandSnippet()

Creates a new CommandSnippet

GeneratedAMSupport.AddComment()

Creates a new child Comment.

GeneratedAMSupport.AddFigure()

Creates a new child Figure.

GeneratedAMSupport.AddImage(filePath: str)

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.

GeneratedAMSupport.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

GeneratedAMSupport.CreateNamedSelectionOfGeneratedElements()

Run the PromoteToNamedSelection action.

GeneratedAMSupport.CreateParameter(propName: str)

Creates a new parameter for a Property.

GeneratedAMSupport.Delete()

Run the Delete action.

GeneratedAMSupport.Duplicate()

Creates a copy of the current DataModelObject.

GeneratedAMSupport.GenerateSupportBodies(progress: Ansys.Mechanical.Application.Progress)

Generate Support Bodies.

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

Gets the list of children, filtered by type.

GeneratedAMSupport.GetGeneratedBody()

Returns the generated body object

GeneratedAMSupport.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

GeneratedAMSupport.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

GeneratedAMSupport.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

GeneratedAMSupport.PropertyByName(name: str)

Get a property by its unique name.

GeneratedAMSupport.RemoveParameter(propName: str)

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