:py:mod:`eelib.data.collector`
==============================

.. py:module:: eelib.data.collector

.. autoapi-nested-parse::

   Simple collector simulator based on the one defined within the mosaik tutorial:
   https://mosaik.readthedocs.io/en/latest/
   Prints all inputs immediately.

   @author: elenia@TUBS



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

Classes
~~~~~~~

.. autoapisummary::

   eelib.data.collector.Collector




Attributes
~~~~~~~~~~

.. autoapisummary::

   eelib.data.collector.META


.. py:data:: META

   

.. py:class:: Collector


   Bases: :py:obj:`mosaik_api_v3.Simulator`

   Collector simualtor to provide simple prints in each step.

   .. py:method:: init(sid, time_resolution)

      Init of a simulator instance.

      :param sid: _description_
      :type sid: _type_
      :param time_resolution: _description_
      :type time_resolution: _type_

      :returns: _description_
      :rtype: _type_


   .. py:method:: create(num, model)

      Create mosaik sim of the collector.

      :param num: _description_
      :type num: _type_
      :param model: _description_
      :type model: _type_

      :raises RuntimeError: If more than one simulators should be initialized.

      :returns: eid and simulator
      :rtype: dict


   .. py:method:: step(time, inputs, max_advance)

      Step method of the collector simulator.
      Prints all inputs.

      :param time: _description_
      :type time: _type_
      :param inputs: _description_
      :type inputs: _type_
      :param max_advance: _description_
      :type max_advance: _type_

      :returns: max advance until next call of the simulator.
      :rtype: int