`NamedSelection`#

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

Bases: object

Defines a NamedSelection.

Overview#

Methods

`ExportToTextFile`	Run the ExportToTextFile action.
`ExportNamedSelectionToCDBFile`	Export Named Selection to CDB file
`Generate`	Generates the selection based on the generation criteria.
`CreateNodalNamedSelection`	Creates a new Named Selection object containing all the nodes from the entities in the current named selection .
`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

`Location`	Gets or sets the Location.
`GenerationCriteria`	Returns the generation criteria that is used to generate the selection.
`InternalObject`	Gets the internal object. For advanced usage only.
`CrackFrontNumber`	Gets the CrackFrontNumber.
`LSDynaUserId`	Gets or sets the LSDynaUserId.
`TotalSelection`	Gets the TotalSelection.
`Suppressed`	Gets the Suppressed.
`RelativeTolerance`	Gets or sets the RelativeTolerance.
`ZeroTolerance`	Gets or sets the ZeroTolerance.
`ScopingMethod`	Gets or sets the ScopingMethod.
`SendAs`	Gets or sets the SendAs.
`ToleranceType`	Gets or sets the ToleranceType.
`Type`	Gets the Type.
`IncludeProgramControlledInflation`	Gets or sets the IncludeProgramControlledInflation.
`PreserveDuringSolve`	Gets or sets the PreserveDuringSolve.
`SendToSolver`	Gets or sets the SendToSolver.
`Visible`	Gets or sets the Visible.
`UsedByMeshWorksheet`	Gets the UsedByMeshWorksheet.
`CreatedForCrack`	Gets the CreatedForCrack.
`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.
`ReadOnly`	Gets or sets the ReadOnly.
`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 NamedSelection.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property NamedSelection.GenerationCriteria: Ansys.ACT.Automation.Mechanical.NamedSelectionCriteria | None: Returns the generation criteria that is used to generate the selection.

property NamedSelection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSComponentAuto | None: Gets the internal object. For advanced usage only.

property NamedSelection.CrackFrontNumber: System.Int32 | None: Gets the CrackFrontNumber.

property NamedSelection.LSDynaUserId: System.Int32 | None: Gets or sets the LSDynaUserId.

property NamedSelection.TotalSelection: System.Int32 | None: Gets the TotalSelection.

property NamedSelection.Suppressed: System.Int32 | None: Gets the Suppressed.

property NamedSelection.RelativeTolerance: System.Double | None: Gets or sets the RelativeTolerance.

property NamedSelection.ZeroTolerance: System.Double | None: Gets or sets the ZeroTolerance.

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.ToleranceType: Ansys.Mechanical.DataModel.Enums.ToleranceType | None: Gets or sets the ToleranceType.

property NamedSelection.Type: System.Boolean | None: Gets the Type.

property NamedSelection.IncludeProgramControlledInflation: System.Boolean | None: Gets or sets the IncludeProgramControlledInflation.

property NamedSelection.PreserveDuringSolve: System.Boolean | None: Gets or sets the PreserveDuringSolve.

property NamedSelection.SendToSolver: System.Boolean | None: Gets or sets the SendToSolver.

property NamedSelection.Visible: System.Boolean | None: Gets or sets the Visible.

property NamedSelection.UsedByMeshWorksheet: System.Boolean | None: Gets the UsedByMeshWorksheet.

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.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

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

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

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

property NamedSelection.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

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

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

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

Method detail#

NamedSelection.ExportToTextFile(filePath: System.String) → System.Void: Run the ExportToTextFile action.

NamedSelection.ExportNamedSelectionToCDBFile(filepath: System.String) → System.Void: Export Named Selection to CDB file

NamedSelection.Generate() → System.Void: Generates the selection based on the generation criteria.

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.Delete() → System.Void: Run the Delete action.

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

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

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

NamedSelection.Activate() → System.Void: Activate the current object.

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

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

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

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

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

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

NamedSelection.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

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

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