NamedSelections

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.NamedSelections

Bases: object

Defines a NamedSelections.

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.
AddNamedSelection	Creates a new NamedSelection
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.
ExportNamedSelectionToCDBFile	Export Named Selections to CDB file
GenerateAllNamedSelections	Generate all named selections specified with the Worksheet
GetChildren	Gets the list of children, filtered by type.
GetParameter	Gets the parameter corresponding to the given property.
GoToNamedSelectionsCommonToSelection	GoToNamedSelectionsCommonToSelection method.
GoToNamedSelectionsContainingSelection	GoToNamedSelectionsContainingSelection method.
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.
GenerateOnRefresh	Gets or sets the GenerateOnRefresh.
GenerateOnRemesh	Gets or sets the GenerateOnRemesh.
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.
RandomColors	Gets the RandomColors.
ShowAnnotations	Gets or sets the ShowAnnotations.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property NamedSelections.GenerateOnRefresh: bool | None

Gets or sets the GenerateOnRefresh.

property NamedSelections.GenerateOnRemesh: bool | None

Gets or sets the GenerateOnRemesh.

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

Gets the list of associated images.

property NamedSelections.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSComponentGroupAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property NamedSelections.RandomColors: bool | None

Gets the RandomColors.

property NamedSelections.ShowAnnotations: bool | None

Gets or sets the ShowAnnotations.

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

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

Method detail

NamedSelections.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

NamedSelections.AddNamedSelection() → Ansys.ACT.Automation.Mechanical.NamedSelection

Creates a new NamedSelection

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

NamedSelections.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

NamedSelections.ExportNamedSelectionToCDBFile(filepath: str) → None

Export Named Selections to CDB file

NamedSelections.GenerateAllNamedSelections() → None

Generate all named selections specified with the Worksheet

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

NamedSelections.GoToNamedSelectionsCommonToSelection() → None

GoToNamedSelectionsCommonToSelection method.

NamedSelections.GoToNamedSelectionsContainingSelection() → None

GoToNamedSelectionsContainingSelection method.

NamedSelections.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

NamedSelections.RemoveParameter(propName: str) → None

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