StringMetadata
==============

.. py:class:: StringMetadata
   :canonical: ansys.tools.variableinterop.scalar_metadata.StringMetadata



Bases: :py:obj:`ansys.tools.variableinterop.common_variable_metadata.CommonVariableMetadata`

Provides common metadata for ``STRING`` and ``STRING_ARRAY`` variable types.















Overview
--------
.. py:currentmodule:: StringMetadata
.. tab-set::



    .. tab-item:: Methods

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

          * - :py:attr:`~accept`
            - Invoke the visitor pattern of this object using the passed-in visitor
          * - :py:attr:`~equals`
            - Determine if the object is equal to the metadata.


    .. tab-item:: Properties

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

          * - :py:attr:`~variable_type`
            - Variable type of the object.
          * - :py:attr:`~enumerated_values`
            - List of enumerated values.
          * - :py:attr:`~enumerated_aliases`
            - List of enumerated aliases.




    .. tab-item:: Special methods

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

          * - :py:attr:`~__eq__`
            - Determine if the object is equal to the metadata.



Import detail
-------------

.. code-block:: python

    from ansys.tools.variableinterop.scalar_metadata import StringMetadata


Property detail
---------------
.. py:property:: variable_type
   :canonical: ansys.tools.variableinterop.scalar_metadata.StringMetadata.variable_type
   :type: VariableType


   
   Variable type of the object.



   :Returns:

       :obj:`VariableType`
           Variable type of the object.













   ..
       !! processed by numpydoc !!

.. py:property:: enumerated_values
   :canonical: ansys.tools.variableinterop.scalar_metadata.StringMetadata.enumerated_values
   :type: List[ansys.tools.variableinterop.scalar_values.StringValue]


   
   List of enumerated values.

   This list may be empty to imply that there are no enumerated values.


   :Returns:

       :obj:`List`\[:obj:`StringValue`]
           List of enumerated values.













   ..
       !! processed by numpydoc !!

.. py:property:: enumerated_aliases
   :canonical: ansys.tools.variableinterop.scalar_metadata.StringMetadata.enumerated_aliases
   :type: List[str]


   
   List of enumerated aliases.

   This list may be empty to imply that there are no enumerated aliases.


   :Returns:

       :obj:`List`\[:class:`python:str`]
           List of enumerated aliases.













   ..
       !! processed by numpydoc !!




Method detail
-------------
.. py:method:: __eq__(other)

   
   Determine if the object is equal to the metadata.
















   ..
       !! processed by numpydoc !!

.. py:method:: accept(visitor: ansys.tools.variableinterop.ivariablemetadata_visitor.IVariableMetadataVisitor[ansys.tools.variableinterop.ivariablemetadata_visitor.T]) -> ansys.tools.variableinterop.ivariablemetadata_visitor.T

   
   Invoke the visitor pattern of this object using the passed-in visitor
   implementation.


   :Parameters:

       **visitor** : :obj:`IVariableMetadataVisitor`\[:obj:`T`]
           Visitor object to call.

   :Returns:

       :obj:`T`
           Results of the visitor invocation.













   ..
       !! processed by numpydoc !!

.. py:method:: equals(other: Any) -> bool

   
   Determine if the object is equal to the metadata.


   :Parameters:

       **other** : :obj:`Any`
           Other object to compare this object to.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` if the metadata objects are equal, ``False`` otherwise.













   ..
       !! processed by numpydoc !!