.. vale off :class:`MappingValidation` ========================== .. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.MappingValidation(internalObject: Any) 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:`~CreateObjRef` - CreateObjRef method. * - :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:`~Equals` - Equals method. * - :py:attr:`~GetAPIName` - Property name bound to dispId. * - :py:attr:`~GetAllProperties` - GetAllProperties method. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetEnumName` - Enum name bound to value * - :py:attr:`~GetHashCode` - GetHashCode method. * - :py:attr:`~GetIconFile` - GetIconFile method. * - :py:attr:`~GetLifetimeService` - GetLifetimeService method. * - :py:attr:`~GetObjectData` - GetObjectData method. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GetPath` - GetPath method. * - :py:attr:`~GetPropertyName` - GetPropertyName method. * - :py:attr:`~GetPropertyValue` - GetPropertyValue method. * - :py:attr:`~GetType` - GetType method. * - :py:attr:`~GetVisibleProperties` - GetVisibleProperties method. * - :py:attr:`~GetVisiblePropertyNames` - GetVisiblePropertyNames method. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~InitializeLifetimeService` - InitializeLifetimeService method. * - :py:attr:`~IsPropertyEditable` - IsPropertyEditable method. * - :py:attr:`~IsPropertyVisible` - IsPropertyVisible method. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyById` - PropertyById method. * - :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:`~ToString` - ToString method. .. 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:`~GroupingFolder` - GroupingFolder property. * - :py:attr:`~IconName` - IconName property. * - :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:`~Name` - Name property. * - :py:attr:`~ObjectId` - ObjectId property. * - :py:attr:`~ObjectState` - ObjectState property. * - :py:attr:`~ObjectTags` - ObjectTags property. * - :py:attr:`~Parent` - Parent 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:`~State` - State property. * - :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:: GroupingFolder :type: Optional[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] GroupingFolder property. .. !! processed by numpydoc !! .. py:property:: IconName :type: Optional[str] IconName property. .. !! 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:: Name :type: Optional[str] Name property. .. !! processed by numpydoc !! .. py:property:: ObjectId :type: Optional[int] ObjectId property. .. !! processed by numpydoc !! .. py:property:: ObjectState :type: Optional[Ansys.Mechanical.DataModel.Enums.ObjectState] ObjectState property. .. !! processed by numpydoc !! .. py:property:: ObjectTags :type: Optional[Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag]] ObjectTags property. .. !! processed by numpydoc !! .. py:property:: Parent :type: Optional[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] Parent 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:: State :type: Optional[Ansys.Mechanical.DataModel.Enums.Legacy.State] State property. .. !! 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:: CreateObjRef(requestedType: type) -> System.Runtime.Remoting.ObjRef CreateObjRef method. .. !! 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:: Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) -> bool Equals method. .. !! processed by numpydoc !! .. py:method:: GetAPIName(dispId: int) -> str Property name bound to dispId. .. !! processed by numpydoc !! .. py:method:: GetAllProperties() -> List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper] GetAllProperties method. .. !! 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:: GetEnumName(enumType: type, value: int, dispId: int) -> str Enum name bound to value .. !! processed by numpydoc !! .. py:method:: GetHashCode() -> int GetHashCode method. .. !! processed by numpydoc !! .. py:method:: GetIconFile() -> System.Byte GetIconFile method. .. !! processed by numpydoc !! .. py:method:: GetLifetimeService() -> Any GetLifetimeService method. .. !! processed by numpydoc !! .. py:method:: GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) -> None GetObjectData method. .. !! 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:: GetPath() -> str GetPath method. .. !! processed by numpydoc !! .. py:method:: GetPropertyName(dispId: int) -> str GetPropertyName method. .. !! processed by numpydoc !! .. py:method:: GetPropertyValue(name: str) -> Any GetPropertyValue method. .. !! processed by numpydoc !! .. py:method:: GetType() -> type GetType method. .. !! processed by numpydoc !! .. py:method:: GetVisibleProperties() -> List[System.Reflection.PropertyInfo] GetVisibleProperties method. .. !! processed by numpydoc !! .. py:method:: GetVisiblePropertyNames() -> List[str] GetVisiblePropertyNames method. .. !! 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:: InitializeLifetimeService() -> Any InitializeLifetimeService method. .. !! processed by numpydoc !! .. py:method:: IsPropertyEditable(dispId: int) -> bool IsPropertyEditable method. .. !! processed by numpydoc !! .. py:method:: IsPropertyVisible(dispId: int) -> bool IsPropertyVisible method. .. !! 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:: PropertyById(dispId: int) -> Ansys.ACT.Automation.Mechanical.Property PropertyById method. .. !! 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:: ToString() -> str ToString method. .. !! processed by numpydoc !! .. vale on