sgr_commhandler.api.functional_profile_api
==========================================

.. py:module:: sgr_commhandler.api.functional_profile_api


Attributes
----------

.. autoapisummary::

   sgr_commhandler.api.functional_profile_api.TFpSpec


Classes
-------

.. autoapisummary::

   sgr_commhandler.api.functional_profile_api.FunctionalProfile


Module Contents
---------------

.. py:data:: TFpSpec

   Defines a generic functional profile data type.

.. py:class:: FunctionalProfile(fp_spec)

   Bases: :py:obj:`Generic`\ [\ :py:obj:`TFpSpec`\ ]


   Implements a functional profile.


   .. py:attribute:: _fp_spec
      :type:  TFpSpec


   .. py:method:: name()

      Gets the functional profile name.

      :returns: the functional profile name
      :rtype: str



   .. py:method:: get_data_points()

      Gets all data points.

      :returns: all data points
      :rtype: dict[tuple[str, str], DataPoint]



   .. py:method:: get_data_point(dp_name)

      Gets a data point.

      :param dp_name: the data point name
      :type dp_name: str

      :returns: a data point
      :rtype: DataPoint



   .. py:method:: get_values_async(parameters = None)
      :async:


      Gets all data point values of the functional profile asynchronously.

      :returns: all data point values by name
      :rtype: dict[str, Any]



   .. py:method:: describe()

      Describes the functional profile.

      :returns: the functional profile information
      :rtype: tuple[str, dict[str, tuple[DataDirectionProduct, DataTypes]]]



   .. py:method:: get_specification()

      Gets the functional profile specification.

      :returns: the functional profile specification
      :rtype: TFpSpec