.. vale off



:class:`IMechanicalUserObject`
==============================

.. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Interfaces.Mechanical.IMechanicalUserObject

   Bases: :py:obj:`object`


   
   Defines a Mechanical user object.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: IMechanicalUserObject

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~NotifyChange`
            - NotifyChange method.
          * - :py:attr:`~get_AllProperties`
            - get_AllProperties method.
          * - :py:attr:`~get_Attributes`
            - get_Attributes method.
          * - :py:attr:`~get_Caption`
            - get_Caption method.
          * - :py:attr:`~get_Children`
            - get_Children method.
          * - :py:attr:`~get_Controller`
            - get_Controller method.
          * - :py:attr:`~get_Extension`
            - get_Extension method.
          * - :py:attr:`~get_Icon`
            - get_Icon method.
          * - :py:attr:`~get_Id`
            - get_Id method.
          * - :py:attr:`~get_InternalCaption`
            - get_InternalCaption method.
          * - :py:attr:`~get_Name`
            - get_Name method.
          * - :py:attr:`~get_ObjectLocation`
            - get_ObjectLocation method.
          * - :py:attr:`~get_ObjectType`
            - get_ObjectType method.
          * - :py:attr:`~get_Parent`
            - get_Parent method.
          * - :py:attr:`~get_Properties`
            - get_Properties method.
          * - :py:attr:`~get_State`
            - get_State method.
          * - :py:attr:`~get_SupportedLocations`
            - get_SupportedLocations method.
          * - :py:attr:`~get_Version`
            - get_Version method.


   .. tab-item:: Properties

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~AllProperties`
            - AllProperties property.
          * - :py:attr:`~Analysis`
            - Gets the associated analysis.
          * - :py:attr:`~Attributes`
            - Attributes property.
          * - :py:attr:`~Caption`
            - Caption property.
          * - :py:attr:`~Children`
            - Children property.
          * - :py:attr:`~Controller`
            - Controller property.
          * - :py:attr:`~Extension`
            - Extension property.
          * - :py:attr:`~Icon`
            - Icon property.
          * - :py:attr:`~Id`
            - Id property.
          * - :py:attr:`~InternalCaption`
            - InternalCaption property.
          * - :py:attr:`~Name`
            - Name property.
          * - :py:attr:`~ObjectLocation`
            - ObjectLocation property.
          * - :py:attr:`~ObjectType`
            - ObjectType property.
          * - :py:attr:`~Parent`
            - Parent property.
          * - :py:attr:`~Properties`
            - Properties property.
          * - :py:attr:`~State`
            - State property.
          * - :py:attr:`~SupportedLocations`
            - SupportedLocations property.
          * - :py:attr:`~Version`
            - Version property.







Property detail
---------------
.. py:property:: AllProperties
   :type: Optional[Iterable[Ansys.ACT.Interfaces.UserObject.ISimProperty]]


   
   AllProperties property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Analysis
   :type: Optional[Ansys.ACT.Interfaces.Analysis.IAnalysis]


   
   Gets the associated analysis.
















   ..
       !! processed by numpydoc !!

.. py:property:: Attributes
   :type: Optional[Ansys.ACT.Interfaces.Common.IAttributeCollection]


   
   Attributes property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Caption
   :type: Optional[str]


   
   Caption property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Children
   :type: Optional[Iterable[Ansys.ACT.Interfaces.UserObject.IUserObject]]


   
   Children property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Controller
   :type: Optional[Any]


   
   Controller property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Extension
   :type: Optional[Ansys.ACT.Interfaces.Common.IExtension]


   
   Extension property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Icon
   :type: Optional[str]


   
   Icon property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Id
   :type: Optional[int]


   
   Id property.
















   ..
       !! processed by numpydoc !!

.. py:property:: InternalCaption
   :type: Optional[str]


   
   InternalCaption property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Name
   :type: Optional[str]


   
   Name property.
















   ..
       !! processed by numpydoc !!

.. py:property:: ObjectLocation
   :type: Optional[Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum]


   
   ObjectLocation property.
















   ..
       !! processed by numpydoc !!

.. py:property:: ObjectType
   :type: Optional[Ansys.ACT.Interfaces.UserObject.ObjectTypeEnum]


   
   ObjectType property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Parent
   :type: Optional[Ansys.ACT.Interfaces.DataModel.IDataModelObject]


   
   Parent property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Properties
   :type: Optional[Ansys.ACT.Interfaces.UserObject.IPropertyCollection]


   
   Properties property.
















   ..
       !! processed by numpydoc !!

.. py:property:: State
   :type: Optional[str]


   
   State property.
















   ..
       !! processed by numpydoc !!

.. py:property:: SupportedLocations
   :type: Optional[Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum]


   
   SupportedLocations property.
















   ..
       !! processed by numpydoc !!

.. py:property:: Version
   :type: Optional[int]


   
   Version property.
















   ..
       !! processed by numpydoc !!





Method detail
-------------
.. py:method:: NotifyChange() -> None

   
   NotifyChange method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_AllProperties() -> Iterable[Ansys.ACT.Interfaces.UserObject.ISimProperty]

   
   get_AllProperties method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Attributes() -> Ansys.ACT.Interfaces.Common.IAttributeCollection

   
   get_Attributes method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Caption() -> str

   
   get_Caption method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Children() -> Iterable[Ansys.ACT.Interfaces.UserObject.IUserObject]

   
   get_Children method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Controller() -> Any

   
   get_Controller method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Extension() -> Ansys.ACT.Interfaces.Common.IExtension

   
   get_Extension method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Icon() -> str

   
   get_Icon method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Id() -> int

   
   get_Id method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_InternalCaption() -> str

   
   get_InternalCaption method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Name() -> str

   
   get_Name method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_ObjectLocation() -> Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum

   
   get_ObjectLocation method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_ObjectType() -> Ansys.ACT.Interfaces.UserObject.ObjectTypeEnum

   
   get_ObjectType method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Parent() -> Ansys.ACT.Interfaces.DataModel.IDataModelObject

   
   get_Parent method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Properties() -> Ansys.ACT.Interfaces.UserObject.IPropertyCollection

   
   get_Properties method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_State() -> str

   
   get_State method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_SupportedLocations() -> Ansys.ACT.Interfaces.UserObject.ObjectLocationEnum

   
   get_SupportedLocations method.

   ..
       !! processed by numpydoc !!

.. py:method:: get_Version() -> int

   
   get_Version method.

   ..
       !! processed by numpydoc !!



.. vale on