BodyMergeSequence

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BodyMergeSequence

Bases: object

A container for Body Merge operators ordered in a sequence.

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.
ClearGeneratedData	Reverses all previously executed body merge operations, effectively undoing the actions performed by Generate.
CopyTo	Copies all visible properties from this object to another.
CreateAndAppend	Creates new body merge at the end of the sequence and returns the object.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
Generate	Executes all body merge operators in sequential order.
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

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.
Properties	Gets the list of properties for this object.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property BodyMergeSequence.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSBodyMergeTreeNodeGroupAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

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

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

Method detail

BodyMergeSequence.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

BodyMergeSequence.ClearGeneratedData() → None

Reverses all previously executed body merge operations, effectively undoing the actions performed by Generate.

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

Copies all visible properties from this object to another.

BodyMergeSequence.CreateAndAppend() → Ansys.ACT.Automation.Mechanical.BodyMerge

Creates new body merge at the end of the sequence and returns the object.

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

Creates a new parameter for a Property.

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

Creates a copy of the current DataModelObject.

BodyMergeSequence.Generate() → None

Executes all body merge operators in sequential order.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

BodyMergeSequence.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

BodyMergeSequence.RemoveParameter(propName: str) → None

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