NodeMerge

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.NodeMerge

Bases: object

Defines a NodeMerge.

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.
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.
Generate	Run the Generate 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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.

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.
MasterBodies	Gets the MasterBodies.
MasterLocation	Gets or sets the MasterLocation.
Properties	Gets the list of properties for this object.
ScopingMethod	ScopingMethod property.
SlaveBodies	Gets the SlaveBodies.
SlaveLocation	Gets or sets the SlaveLocation.
Suppressed	Gets or sets the Suppressed.
ToleranceType	Gets or sets the ToleranceType.
ToleranceValue	Gets/ Sets the ToleranceValue.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property NodeMerge.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMeshConnectionAuto | None

Gets the internal object. For advanced usage only.

property NodeMerge.MasterBodies: str | None

Gets the MasterBodies.

property NodeMerge.MasterLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the MasterLocation.

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

Gets the list of properties for this object.

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

ScopingMethod property.

property NodeMerge.SlaveBodies: str | None

Gets the SlaveBodies.

property NodeMerge.SlaveLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the SlaveLocation.

property NodeMerge.Suppressed: bool | None

Gets or sets the Suppressed.

property NodeMerge.ToleranceType: Ansys.Mechanical.DataModel.Enums.ContactToleranceType | None

Gets or sets the ToleranceType.

property NodeMerge.ToleranceValue: Ansys.Core.Units.Quantity | None

Gets/ Sets the ToleranceValue.

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

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

Method detail

NodeMerge.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

NodeMerge.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

NodeMerge.Generate() → None

Run the Generate action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

NodeMerge.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

NodeMerge.RemoveParameter(propName: str) → None

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

NodeMerge.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.