.. vale off :class:`MappingValidation` ========================== .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MappingValidation Bases: :py:obj:`object` Defines a MappingValidation. .. !! processed by numpydoc !! .. py:currentmodule:: MappingValidation 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:`~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:`~ActiveSequence` - Gets or sets the ActiveSequence. * - :py:attr:`~ActiveSequenceByValue` - Gets or sets the ActiveSequenceByValue. * - :py:attr:`~BoundingTolerance` - Gets or sets the BoundingTolerance. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~ComplexComponent` - Gets or sets the ComplexComponent. * - :py:attr:`~Component` - Gets or sets the Component. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~DefineActiveSequenceBy` - Control whether the active sequenced is defined by row or by value. * - :py:attr:`~Display` - Display property. * - :py:attr:`~DisplayDataType` - Gets or sets the DisplayDataType. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~FileIdentifierIndex` - Gets or sets the FileIdentifierIndex. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~IsolineThickness` - IsolineThickness property. * - :py:attr:`~IsolineType` - IsolineType property. * - :py:attr:`~Layer` - Gets or sets the Layer. * - :py:attr:`~LegendDivisions` - LegendDivisions property. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~Scale` - Scale property. * - :py:attr:`~ShellFace` - Controls whether the displayed shell face lies on the bottom, middle, or top of the shell. * - :py:attr:`~Type` - Type property. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: ActiveSequence :type: Optional[int] Gets or sets the ActiveSequence. .. !! processed by numpydoc !! .. py:property:: ActiveSequenceByValue :type: Optional[float] Gets or sets the ActiveSequenceByValue. .. !! processed by numpydoc !! .. py:property:: BoundingTolerance :type: Optional[float] Gets or sets the BoundingTolerance. .. !! 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:: ComplexComponent :type: Optional[bool] Gets or sets the ComplexComponent. .. !! processed by numpydoc !! .. py:property:: Component :type: Optional[Ansys.Mechanical.DataModel.Enums.ExternalLoadDisplayComponentType] Gets or sets the Component. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: DefineActiveSequenceBy :type: Optional[Ansys.Mechanical.DataModel.Enums.ExternalLoadDefineActiveSequenceBy] Control whether the active sequenced is defined by row or by value. .. !! processed by numpydoc !! .. py:property:: Display :type: Optional[Ansys.Mechanical.DataModel.Enums.MappingValidationDisplayOption] Display property. .. !! processed by numpydoc !! .. py:property:: DisplayDataType :type: Optional[Ansys.Mechanical.DataModel.Enums.ExternalLoadDisplayDataType] Gets or sets the DisplayDataType. .. !! 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:: FileIdentifierIndex :type: Optional[int] Gets or sets the FileIdentifierIndex. .. !! 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.IDSMappingValidationAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: IsolineThickness :type: Optional[Ansys.Mechanical.DataModel.Enums.MappingIsolineThicknessType] IsolineThickness property. .. !! processed by numpydoc !! .. py:property:: IsolineType :type: Optional[Ansys.Mechanical.DataModel.Enums.MappingIsolineLineType] IsolineType property. .. !! processed by numpydoc !! .. py:property:: Layer :type: Optional[int] Gets or sets the Layer. .. !! processed by numpydoc !! .. py:property:: LegendDivisions :type: Optional[int] LegendDivisions property. .. !! 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:: Scale :type: Optional[float] Scale property. .. !! processed by numpydoc !! .. py:property:: ShellFace :type: Optional[Ansys.Mechanical.DataModel.Enums.ShellFaceType] Controls whether the displayed shell face lies on the bottom, middle, or top of the shell. .. !! processed by numpydoc !! .. py:property:: Type :type: Optional[Ansys.Mechanical.DataModel.Enums.MappingValidationType] Type property. .. !! 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:: 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