.. vale off :class:`SymmetryRegion` ======================= .. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.SymmetryRegion Bases: :py:obj:`object` Defines a SymmetryRegion. .. !! processed by numpydoc !! .. py:currentmodule:: SymmetryRegion 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:`~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:`~FlipHighLow` - Flips the High and Low Boundaries. * - :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:`~ApplyTo` - Gets or sets the ApplyTo. * - :py:attr:`~Behavior` - Gets or sets the Behavior. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~CoordinateSystem` - Gets or sets the CoordinateSystem. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~HighBoundaryLocation` - Gets or sets the HighBoundaryLocation. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~LinearShift` - Gets or sets the LinearShift. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~LowBoundaryLocation` - Gets or sets the LowBoundaryLocation. * - :py:attr:`~PeriodicityDirection` - Gets or sets the PeriodicityDirection. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~ScopeMode` - Gets the ScopeMode. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~SymmetryNormal` - Gets or sets the SymmetryNormal. * - :py:attr:`~Type` - Gets or sets the Type. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: ApplyTo :type: Optional[Ansys.Mechanical.DataModel.Enums.PeriodicApplyTo] Gets or sets the ApplyTo. .. !! processed by numpydoc !! .. py:property:: Behavior :type: Optional[Ansys.Mechanical.DataModel.Enums.SymmetryBehavior] Gets or sets the Behavior. .. !! processed by numpydoc !! .. 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:: CoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the CoordinateSystem. .. !! 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:: HighBoundaryLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the HighBoundaryLocation. .. !! 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.IDSSymmetryGeneralAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: LinearShift :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the LinearShift. .. !! processed by numpydoc !! .. py:property:: Location :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: LowBoundaryLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the LowBoundaryLocation. .. !! processed by numpydoc !! .. py:property:: PeriodicityDirection :type: Optional[Ansys.Mechanical.DataModel.Enums.PeriodicityDirectionType] Gets or sets the PeriodicityDirection. .. !! 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:: ScopeMode :type: Optional[Ansys.Mechanical.DataModel.Enums.AutomaticOrManual] Gets the ScopeMode. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: SymmetryNormal :type: Optional[Ansys.Mechanical.DataModel.Enums.SymmetryNormalType] Gets or sets the SymmetryNormal. .. !! processed by numpydoc !! .. py:property:: Type :type: Optional[Ansys.Mechanical.DataModel.Enums.SymmetryRegionType] Gets or sets the Type. .. !! 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:: 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:: FlipHighLow() -> None Flips the High and Low Boundaries. .. !! 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