.. vale off :class:`ExpansionSettings` ========================== .. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.ExpansionSettings Bases: :py:obj:`object` Defines a ExpansionSettings. .. !! processed by numpydoc !! .. py:currentmodule:: ExpansionSettings 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:`~ClearGeneratedData` - Run the ClearGeneratedData action. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :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:`~EvaluateAllResults` - Run the EvaluateAllResults action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetCompletedExpansionState` - Gets the completed expansion state of a given Condensed Part * - :py:attr:`~GetExpansionState` - Gets the requested expansion state of a given Condensed Part * - :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:`~PerformExpansionPass` - Run the PerformExpansionPass 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. * - :py:attr:`~SetExpansionState` - Sets the requested expansion state of a given Condensed Part .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~CleanupOptionalFiles` - Gets or sets the CleanupOptionalFiles. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~CondensedPartExpansionType` - Gets or sets the CondensedPartExpansionType. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~ExpandAfterUsePassFailure` - Gets or sets the ExpandAfterUsePassFailure. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~GeneralMiscellaneous` - Gets or sets the GeneralMiscellaneous. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~NodalForces` - Gets or sets the NodalForces. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~Strain` - Gets or sets the Strain. * - :py:attr:`~Stress` - Gets or sets the Stress. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: CleanupOptionalFiles :type: Optional[bool] Gets or sets the CleanupOptionalFiles. .. !! 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:: CondensedPartExpansionType :type: Optional[Ansys.Mechanical.DataModel.Enums.CondensedPartExpansionType] Gets or sets the CondensedPartExpansionType. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: ExpandAfterUsePassFailure :type: Optional[bool] Gets or sets the ExpandAfterUsePassFailure. .. !! 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:: GeneralMiscellaneous :type: Optional[bool] Gets or sets the GeneralMiscellaneous. .. !! 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:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSExpansionSettingsAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: NodalForces :type: Optional[Ansys.Mechanical.DataModel.Enums.OutputControlsNodalForcesType] Gets or sets the NodalForces. .. !! 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:: Strain :type: Optional[bool] Gets or sets the Strain. .. !! processed by numpydoc !! .. py:property:: Stress :type: Optional[bool] Gets or sets the Stress. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! 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 !! 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:: ClearGeneratedData() -> None Run the ClearGeneratedData action. .. !! 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:: 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:: EvaluateAllResults() -> None Run the EvaluateAllResults action. .. !! 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:: GetCompletedExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart) -> Ansys.ACT.Automation.Mechanical.CondensedPartExpansionState Gets the completed expansion state of a given Condensed Part .. !! processed by numpydoc !! .. py:method:: GetExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart) -> Ansys.ACT.Automation.Mechanical.CondensedPartExpansionState Gets the requested expansion state of a given Condensed Part .. !! 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:: PerformExpansionPass() -> None Run the PerformExpansionPass 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 !! .. py:method:: SetExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart, state: Ansys.ACT.Automation.Mechanical.CondensedPartExpansionState) -> None Sets the requested expansion state of a given Condensed Part .. !! processed by numpydoc !! .. vale on