Skip to main content

Mechanical scripting interface

BeamTool

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.BeamToolResults.BeamTool

Bases: object

Defines a BeamTool.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddDirectStress Creates a new DirectStress
AddDirectionalDeformation Creates a new DirectionalDeformation
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
AddMaximumBendingStress Creates a new MaximumBendingStress
AddMaximumCombinedStress Creates a new MaximumCombinedStress
AddMinimumBendingStress Creates a new MinimumBendingStress
AddMinimumCombinedStress Creates a new MinimumCombinedStress
AddTotalDeformation Creates a new TotalDeformation
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
EvaluateAllResults Run the EvaluateAllResults action.
GetChildren Gets the list of children, filtered by type.
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.
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.
Properties Gets the list of properties for this object.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property BeamTool.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSBeamToolAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

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

Gets the list of properties for this object.

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

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

Method detail

BeamTool.Activate()

Activate the current object.

BeamTool.AddComment()

Creates a new child Comment.

BeamTool.AddDirectStress()

Creates a new DirectStress

BeamTool.AddDirectionalDeformation()

Creates a new DirectionalDeformation

BeamTool.AddFigure()

Creates a new child Figure.

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

BeamTool.AddMaximumBendingStress()

Creates a new MaximumBendingStress

BeamTool.AddMaximumCombinedStress()

Creates a new MaximumCombinedStress

BeamTool.AddMinimumBendingStress()

Creates a new MinimumBendingStress

BeamTool.AddMinimumCombinedStress()

Creates a new MinimumCombinedStress

BeamTool.AddTotalDeformation()

Creates a new TotalDeformation

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

Copies all visible properties from this object to another.

BeamTool.CreateParameter(propName: str)

Creates a new parameter for a Property.

BeamTool.Delete()

Run the Delete action.

BeamTool.Duplicate()

Creates a copy of the current DataModelObject.

BeamTool.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Gets the list of children, filtered by type.

BeamTool.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

BeamTool.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

BeamTool.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

BeamTool.PropertyByName(name: str)

Get a property by its unique name.

BeamTool.RemoveParameter(propName: str)

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