NamedSelection

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

Bases: object

Defines a NamedSelection.

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.
CreateNodalNamedSelection	Creates a new Named Selection object containing all the nodes from the entities in the current named selection .
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
ExportNamedSelectionToCDBFile	Export Named Selection to CDB file
ExportToTextFile	Run the ExportToTextFile action.
Generate	Generates the selection based on the generation criteria.
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.
CrackFrontNumber	Gets the CrackFrontNumber.
CreatedForCrack	Gets the CreatedForCrack.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
GenerationCriteria	Returns the generation criteria that is used to generate the selection.
Images	Gets the list of associated images.
IncludeProgramControlledInflation	Gets or sets the IncludeProgramControlledInflation.
InternalObject	Gets the internal object. For advanced usage only.
LSDynaUserId	Gets or sets the LSDynaUserId.
Location	Gets or sets the Location.
PreserveDuringSolve	Gets or sets the PreserveDuringSolve.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
RelativeTolerance	Gets or sets the RelativeTolerance.
ScopingMethod	Gets or sets the ScopingMethod.
SendAs	Gets or sets the SendAs.
SendToSolver	Gets or sets the SendToSolver.
Suppressed	Gets the Suppressed.
ToleranceType	Gets or sets the ToleranceType.
TotalSelection	Gets the TotalSelection.
Type	Gets the Type.
UsedByMeshWorksheet	Gets the UsedByMeshWorksheet.
Visible	Gets or sets the Visible.
VisibleProperties	Gets the list of properties that are visible for this object.
ZeroTolerance	Gets or sets the ZeroTolerance.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property NamedSelection.CrackFrontNumber: int | None

Gets the CrackFrontNumber.

property NamedSelection.CreatedForCrack: Ansys.ACT.Automation.Mechanical.GenericCrack | None

Gets the CreatedForCrack.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property NamedSelection.GenerationCriteria: Ansys.ACT.Automation.Mechanical.NamedSelectionCriteria | None

Returns the generation criteria that is used to generate the selection.

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

Gets the list of associated images.

property NamedSelection.IncludeProgramControlledInflation: bool | None

Gets or sets the IncludeProgramControlledInflation.

property NamedSelection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSComponentAuto | None

Gets the internal object. For advanced usage only.

property NamedSelection.LSDynaUserId: int | None

Gets or sets the LSDynaUserId.

property NamedSelection.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property NamedSelection.PreserveDuringSolve: bool | None

Gets or sets the PreserveDuringSolve.

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

Gets the list of properties for this object.

property NamedSelection.ReadOnly: bool | None

Gets or sets the ReadOnly.

property NamedSelection.RelativeTolerance: float | None

Gets or sets the RelativeTolerance.

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

Gets or sets the ScopingMethod.

property NamedSelection.SendAs: Ansys.Mechanical.DataModel.Enums.SendAs | None

Gets or sets the SendAs.

property NamedSelection.SendToSolver: bool | None

Gets or sets the SendToSolver.

property NamedSelection.Suppressed: int | None

Gets the Suppressed.

property NamedSelection.ToleranceType: Ansys.Mechanical.DataModel.Enums.ToleranceType | None

Gets or sets the ToleranceType.

property NamedSelection.TotalSelection: int | None

Gets the TotalSelection.

property NamedSelection.Type: bool | None

Gets the Type.

property NamedSelection.UsedByMeshWorksheet: bool | None

Gets the UsedByMeshWorksheet.

property NamedSelection.Visible: bool | None

Gets or sets the Visible.

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

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

property NamedSelection.ZeroTolerance: float | None

Gets or sets the ZeroTolerance.

Method detail

NamedSelection.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

NamedSelection.CreateNodalNamedSelection() → Ansys.ACT.Automation.Mechanical.NamedSelection

Creates a new Named Selection object containing all the nodes from the entities in the current named selection .

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

Creates a new parameter for a Property.

NamedSelection.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

NamedSelection.ExportNamedSelectionToCDBFile(filepath: str) → None

Export Named Selection to CDB file

NamedSelection.ExportToTextFile(filePath: str) → None

Run the ExportToTextFile action.

NamedSelection.Generate() → None

Generates the selection based on the generation criteria.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

NamedSelection.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

NamedSelection.RemoveParameter(propName: str) → None

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