BodyMergeSequence

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

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
Generate	Executes all body merge operators in sequential order.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
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.
HasBeenExecuted	HasBeenExecuted method.
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.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PreAction	PreAction property.
Properties	Gets the list of properties for this object.
State	State property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property BodyMergeSequence.AttachedRefs: List[int] | None

AttachedRefs property.

property BodyMergeSequence.CanRemove: bool | None

CanRemove property.

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

Gets the list of children.

property BodyMergeSequence.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property BodyMergeSequence.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property BodyMergeSequence.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property BodyMergeSequence.PreAction: System.Action | None

PreAction property.

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

Gets the list of properties for this object.

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

State property.

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.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

BodyMergeSequence.Generate() → None

Executes all body merge operators in sequential order.

BodyMergeSequence.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

BodyMergeSequence.GetHashCode() → int

GetHashCode method.

BodyMergeSequence.GetIconFile() → System.Byte

GetIconFile method.

BodyMergeSequence.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

BodyMergeSequence.GetPath() → str

GetPath method.

BodyMergeSequence.GetPropertyName(dispId: int) → str

GetPropertyName method.

BodyMergeSequence.GetPropertyValue(name: str) → Any

GetPropertyValue method.

BodyMergeSequence.GetType() → type

GetType method.

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

GetVisibleProperties method.

BodyMergeSequence.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

BodyMergeSequence.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

BodyMergeSequence.HasBeenExecuted() → bool

HasBeenExecuted method.

BodyMergeSequence.InitializeLifetimeService() → Any

InitializeLifetimeService method.

BodyMergeSequence.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

BodyMergeSequence.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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.

BodyMergeSequence.ToString() → str

ToString method.