FileArrayDatapin
================

.. py:class:: FileArrayDatapin(element_id: ansys.api.modelcenter.v0.element_messages_pb2.ElementId, engine: ansys.modelcenter.workflow.grpc_modelcenter.engine.Engine)
   :canonical: ansys.modelcenter.workflow.grpc_modelcenter.file_datapin.FileArrayDatapin



Bases: :py:obj:`ansys.modelcenter.workflow.grpc_modelcenter.base_datapin.BaseDatapin`, :py:obj:`ansys.modelcenter.workflow.api.IFileArrayDatapin`


   Represents a file array datapin.

   .. note::
       This class should not be directly instantiated by clients. Get a ``Workflow`` object from
       an instantiated ``Engine`` instance and use it to get a valid instance of this object.















   ..
       !! processed by numpydoc !!
















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



    .. tab-item:: Methods

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

          * - :py:attr:`~get_metadata`
            - Get the metadata for the datapin.
          * - :py:attr:`~set_metadata`
            - Set the standard metadata for the datapin.
          * - :py:attr:`~set_state`
            - Set the state of the datapin.





    .. tab-item:: Special methods

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

          * - :py:attr:`~__eq__`
            - Return self==value.



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

.. code-block:: python

    from ansys.modelcenter.workflow.grpc_modelcenter.file_datapin import FileArrayDatapin




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

   
   Return self==value.
















   ..
       !! processed by numpydoc !!

.. py:method:: get_metadata() -> ansys.tools.variableinterop.FileArrayMetadata

   
   Get the metadata for the datapin.
















   ..
       !! processed by numpydoc !!

.. py:method:: set_metadata(new_metadata: ansys.tools.variableinterop.CommonVariableMetadata) -> None

   
   Set the standard metadata for the datapin.
















   ..
       !! processed by numpydoc !!

.. py:method:: set_state(state: ansys.tools.variableinterop.VariableState) -> None

   
   Set the state of the datapin.
















   ..
       !! processed by numpydoc !!