.. 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:`~Activate` - Activate the current object. * - :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:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateNodalNamedSelection` - Creates a new Named Selection object containing all the nodes from the entities in the current named selection . * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~ExportNamedSelectionToCDBFile` - Export Named Selection to CDB file * - :py:attr:`~ExportToTextFile` - Run the ExportToTextFile action. * - :py:attr:`~Generate` - Generates the selection based on the generation criteria. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :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:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~CrackFrontNumber` - Gets the CrackFrontNumber. * - :py:attr:`~CreatedForCrack` - Gets the CreatedForCrack. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~GenerationCriteria` - Returns the generation criteria that is used to generate the selection. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~IncludeProgramControlledInflation` - Gets or sets the IncludeProgramControlledInflation. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~LSDynaUserId` - Gets or sets the LSDynaUserId. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~PreserveDuringSolve` - Gets or sets the PreserveDuringSolve. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~RelativeTolerance` - Gets or sets the RelativeTolerance. * - :py:attr:`~ScopingMethod` - Gets or sets the ScopingMethod. * - :py:attr:`~SendAs` - Gets or sets the SendAs. * - :py:attr:`~SendToSolver` - Gets or sets the SendToSolver. * - :py:attr:`~Suppressed` - Gets the Suppressed. * - :py:attr:`~ToleranceType` - Gets or sets the ToleranceType. * - :py:attr:`~TotalSelection` - Gets the TotalSelection. * - :py:attr:`~Type` - Gets the Type. * - :py:attr:`~UsedByMeshWorksheet` - Gets the UsedByMeshWorksheet. * - :py:attr:`~Visible` - Gets or sets the Visible. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. * - :py:attr:`~ZeroTolerance` - Gets or sets the ZeroTolerance. Property detail --------------- .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: CrackFrontNumber :type: Optional[int] Gets the CrackFrontNumber. .. !! processed by numpydoc !! .. py:property:: CreatedForCrack :type: Optional[Ansys.ACT.Automation.Mechanical.GenericCrack] Gets the CreatedForCrack. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: GenerationCriteria :type: Optional[Ansys.ACT.Automation.Mechanical.NamedSelectionCriteria] Returns the generation criteria that is used to generate the selection. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: IncludeProgramControlledInflation :type: Optional[bool] Gets or sets the IncludeProgramControlledInflation. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSComponentAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: LSDynaUserId :type: Optional[int] Gets or sets the LSDynaUserId. .. !! processed by numpydoc !! .. py:property:: Location :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: PreserveDuringSolve :type: Optional[bool] Gets or sets the PreserveDuringSolve. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: ReadOnly :type: Optional[bool] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: RelativeTolerance :type: Optional[float] Gets or sets the RelativeTolerance. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ScopingMethod. .. !! processed by numpydoc !! .. py:property:: SendAs :type: Optional[Ansys.Mechanical.DataModel.Enums.SendAs] Gets or sets the SendAs. .. !! processed by numpydoc !! .. py:property:: SendToSolver :type: Optional[bool] Gets or sets the SendToSolver. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[int] Gets the Suppressed. .. !! processed by numpydoc !! .. py:property:: ToleranceType :type: Optional[Ansys.Mechanical.DataModel.Enums.ToleranceType] Gets or sets the ToleranceType. .. !! processed by numpydoc !! .. py:property:: TotalSelection :type: Optional[int] Gets the TotalSelection. .. !! processed by numpydoc !! .. py:property:: Type :type: Optional[bool] Gets the Type. .. !! processed by numpydoc !! .. py:property:: UsedByMeshWorksheet :type: Optional[bool] Gets the UsedByMeshWorksheet. .. !! processed by numpydoc !! .. py:property:: Visible :type: Optional[bool] Gets or sets the Visible. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! .. py:property:: ZeroTolerance :type: Optional[float] Gets or sets the ZeroTolerance. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. 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:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateNodalNamedSelection() -> Ansys.ACT.Automation.Mechanical.NamedSelection Creates a new Named Selection object containing all the nodes from the entities in the current named selection . .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: ExportNamedSelectionToCDBFile(filepath: str) -> None Export Named Selection to CDB file .. !! processed by numpydoc !! .. py:method:: ExportToTextFile(filePath: str) -> None Run the ExportToTextFile action. .. !! processed by numpydoc !! .. py:method:: Generate() -> None Generates the selection based on the generation criteria. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. 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:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on