atomiq.components.basics.datasink
=================================

.. py:module:: atomiq.components.basics.datasink


Classes
-------

.. autoapisummary::

   atomiq.components.basics.datasink.DataSink
   atomiq.components.basics.datasink.RPCPublisherSink
   atomiq.components.basics.datasink.HEROSink
   atomiq.components.basics.datasink.DatabaseSink
   atomiq.components.basics.datasink.ARTIQDatasetSink


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

.. py:class:: DataSink(*args, **kwargs)

   Bases: :py:obj:`atomiq.components.primitives.Component`


   Represent an abstract data sink and define methods it must provide.


   .. py:method:: submit_env(point, identifier=None, *args, **kwargs)


   .. py:method:: submit_data(field_names, values, identifier=None, *args, **kwargs)
      :abstractmethod:



.. py:class:: RPCPublisherSink(rpc_publisher, topic_prefix = '', default_topic = 'newData', *args, **kwargs)

   Bases: :py:obj:`DataSink`


   Represent an abstract data sink and define methods it must provide.


   .. py:attribute:: kernel_invariants


   .. py:attribute:: rpc_publisher


   .. py:attribute:: default_topic
      :value: 'newData'



   .. py:attribute:: topic_prefix
      :value: ''



   .. py:method:: submit_env(point, identifier=None, *args, **kwargs)


   .. py:method:: submit_data(field_names, values, identifier=None, topic=None)


.. py:class:: HEROSink(*args, **kwargs)

   Bases: :py:obj:`DataSink`


   Represent an abstract data sink and define methods it must provide.


   .. py:method:: submit_env(point, identifier=None, *args, **kwargs)


   .. py:method:: submit_data(field_names, values, identifier=None)


.. py:class:: DatabaseSink(*args, **kwargs)

   Bases: :py:obj:`DataSink`


   Represent an abstract data sink and define methods it must provide.


.. py:class:: ARTIQDatasetSink(*args, **kwargs)

   Bases: :py:obj:`DataSink`


   Represent an abstract data sink and define methods it must provide.