`NamedSelections`#

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

Bases: object

Defines a NamedSelections.

Overview#

Methods

`ExportNamedSelectionToCDBFile`	Export Named Selections to CDB file
`GenerateAllNamedSelections`	Generate all named selections specified with the Worksheet
`GoToNamedSelectionsCommonToSelection`	GoToNamedSelectionsCommonToSelection method.
`GoToNamedSelectionsContainingSelection`	GoToNamedSelectionsContainingSelection method.
`AddNamedSelection`	Creates a new NamedSelection
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`InternalObject`	Gets the internal object. For advanced usage only.
`GenerateOnRefresh`	Gets or sets the GenerateOnRefresh.
`GenerateOnRemesh`	Gets or sets the GenerateOnRemesh.
`RandomColors`	Gets the RandomColors.
`ShowAnnotations`	Gets or sets the ShowAnnotations.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`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 NamedSelections.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSComponentGroupAuto | None: Gets the internal object. For advanced usage only.

property NamedSelections.GenerateOnRefresh: System.Boolean | None: Gets or sets the GenerateOnRefresh.

property NamedSelections.GenerateOnRemesh: System.Boolean | None: Gets or sets the GenerateOnRemesh.

property NamedSelections.RandomColors: System.Boolean | None: Gets the RandomColors.

property NamedSelections.ShowAnnotations: System.Boolean | None: Gets or sets the ShowAnnotations.

property NamedSelections.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property NamedSelections.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property NamedSelections.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property NamedSelections.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property NamedSelections.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property NamedSelections.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property NamedSelections.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property NamedSelections.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

NamedSelections.ExportNamedSelectionToCDBFile(filepath: System.String) → System.Void: Export Named Selections to CDB file

NamedSelections.GenerateAllNamedSelections() → System.Void: Generate all named selections specified with the Worksheet

NamedSelections.GoToNamedSelectionsCommonToSelection() → System.Void: GoToNamedSelectionsCommonToSelection method.

NamedSelections.GoToNamedSelectionsContainingSelection() → System.Void: GoToNamedSelectionsContainingSelection method.

NamedSelections.AddNamedSelection() → Ansys.ACT.Automation.Mechanical.NamedSelection: Creates a new NamedSelection

NamedSelections.Delete() → System.Void: Run the Delete action.

NamedSelections.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

NamedSelections.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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: System.String) → 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.Activate() → System.Void: Activate the current object.

NamedSelections.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

NamedSelections.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

NamedSelections.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

NamedSelections.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

NamedSelections.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

NamedSelections.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

NamedSelections.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

NamedSelections.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.