.. vale off :class:`NamedSelection` ======================= .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.NamedSelection Bases: :py:obj:`object` Defines a NamedSelection. .. !! processed by numpydoc !! .. py:currentmodule:: NamedSelection Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ExportToTextFile` - Run the ExportToTextFile action. * - :py:attr:`~ExportNamedSelectionToCDBFile` - Export Named Selection to CDB file * - :py:attr:`~Generate` - Generates the selection based on the generation criteria. * - :py:attr:`~CreateNodalNamedSelection` - Creates a new Named Selection object containing all the nodes from the entities in the current named selection . * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~GenerationCriteria` - Returns the generation criteria that is used to generate the selection. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~CrackFrontNumber` - Gets the CrackFrontNumber. * - :py:attr:`~LSDynaUserId` - Gets or sets the LSDynaUserId. * - :py:attr:`~TotalSelection` - Gets the TotalSelection. * - :py:attr:`~Suppressed` - Gets the Suppressed. * - :py:attr:`~RelativeTolerance` - Gets or sets the RelativeTolerance. * - :py:attr:`~ZeroTolerance` - Gets or sets the ZeroTolerance. * - :py:attr:`~ScopingMethod` - Gets or sets the ScopingMethod. * - :py:attr:`~SendAs` - Gets or sets the SendAs. * - :py:attr:`~ToleranceType` - Gets or sets the ToleranceType. * - :py:attr:`~Type` - Gets the Type. * - :py:attr:`~IncludeProgramControlledInflation` - Gets or sets the IncludeProgramControlledInflation. * - :py:attr:`~PreserveDuringSolve` - Gets or sets the PreserveDuringSolve. * - :py:attr:`~SendToSolver` - Gets or sets the SendToSolver. * - :py:attr:`~Visible` - Gets or sets the Visible. * - :py:attr:`~UsedByMeshWorksheet` - Gets the UsedByMeshWorksheet. * - :py:attr:`~CreatedForCrack` - Gets the CreatedForCrack. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: Location :no-index: :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: GenerationCriteria :no-index: :type: Optional[Ansys.ACT.Automation.Mechanical.NamedSelectionCriteria] Returns the generation criteria that is used to generate the selection. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSComponentAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: CrackFrontNumber :no-index: :type: Optional[System.Int32] Gets the CrackFrontNumber. .. !! processed by numpydoc !! .. py:property:: LSDynaUserId :no-index: :type: Optional[System.Int32] Gets or sets the LSDynaUserId. .. !! processed by numpydoc !! .. py:property:: TotalSelection :no-index: :type: Optional[System.Int32] Gets the TotalSelection. .. !! processed by numpydoc !! .. py:property:: Suppressed :no-index: :type: Optional[System.Int32] Gets the Suppressed. .. !! processed by numpydoc !! .. py:property:: RelativeTolerance :no-index: :type: Optional[System.Double] Gets or sets the RelativeTolerance. .. !! processed by numpydoc !! .. py:property:: ZeroTolerance :no-index: :type: Optional[System.Double] Gets or sets the ZeroTolerance. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ScopingMethod. .. !! processed by numpydoc !! .. py:property:: SendAs :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.SendAs] Gets or sets the SendAs. .. !! processed by numpydoc !! .. py:property:: ToleranceType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.ToleranceType] Gets or sets the ToleranceType. .. !! processed by numpydoc !! .. py:property:: Type :no-index: :type: Optional[System.Boolean] Gets the Type. .. !! processed by numpydoc !! .. py:property:: IncludeProgramControlledInflation :no-index: :type: Optional[System.Boolean] Gets or sets the IncludeProgramControlledInflation. .. !! processed by numpydoc !! .. py:property:: PreserveDuringSolve :no-index: :type: Optional[System.Boolean] Gets or sets the PreserveDuringSolve. .. !! processed by numpydoc !! .. py:property:: SendToSolver :no-index: :type: Optional[System.Boolean] Gets or sets the SendToSolver. .. !! processed by numpydoc !! .. py:property:: Visible :no-index: :type: Optional[System.Boolean] Gets or sets the Visible. .. !! processed by numpydoc !! .. py:property:: UsedByMeshWorksheet :no-index: :type: Optional[System.Boolean] Gets the UsedByMeshWorksheet. .. !! processed by numpydoc !! .. py:property:: CreatedForCrack :no-index: :type: Optional[Ansys.ACT.Automation.Mechanical.GenericCrack] Gets the CreatedForCrack. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Children :no-index: :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: Figures :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: ReadOnly :no-index: :type: Optional[System.Boolean] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[System.Object] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: ExportToTextFile(filePath: System.String) -> System.Void :no-index: Run the ExportToTextFile action. .. !! processed by numpydoc !! .. py:method:: ExportNamedSelectionToCDBFile(filepath: System.String) -> System.Void :no-index: Export Named Selection to CDB file .. !! processed by numpydoc !! .. py:method:: Generate() -> System.Void :no-index: Generates the selection based on the generation criteria. .. !! processed by numpydoc !! .. py:method:: CreateNodalNamedSelection() -> Ansys.ACT.Automation.Mechanical.NamedSelection :no-index: Creates a new Named Selection object containing all the nodes from the entities in the current named selection . .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) -> System.Collections.Generic.IList[ChildrenType] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: 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] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment :no-index: Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure :no-index: Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: System.String) -> Ansys.ACT.Automation.Mechanical.Image :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: Activate() -> System.Void :no-index: Activate the current object. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> System.Void :no-index: Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject :no-index: Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> System.Void :no-index: Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder :no-index: Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on