cars.orchestrator.registry.abstract_registry
============================================

.. py:module:: cars.orchestrator.registry.abstract_registry

.. autoapi-nested-parse::

   This module contains the abstract registry class



Classes
-------

.. autoapisummary::

   cars.orchestrator.registry.abstract_registry.AbstractCarsDatasetRegistry


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

.. py:class:: AbstractCarsDatasetRegistry(id_generator)

   AbstractCarsDatasetRegistry
   This is the abstract class of registries, managing delayed CarsDatasets



   .. py:attribute:: id_generator


   .. py:method:: cars_dataset_in_registry(cars_ds)
      :abstractmethod:


      Check if a CarsDataset is already registered, return id if exists

      :param cars_ds: cars dataset
      :type cars_ds: CarsDataset

      :return : True if in registry, if of cars dataset
      :rtype : Tuple(bool, int)



   .. py:method:: get_cars_datasets_list()
      :abstractmethod:


      Get a list of registered CarsDataset

      :return list of CarsDataset
      :rtype: list(CarsDataset)



   .. py:method:: get_cars_ds(future_result)
      :abstractmethod:


      Get a list of registered CarsDataset

      :param future_result: object to get cars dataset from

      :return corresponding CarsDataset
      :rtype: CarsDataset



   .. py:method:: get_future_cars_dataset_id(future_result)
      :staticmethod:


      Get cars dataset id for current future result

      :param future_result: future result:
      :type future_result: xr.Dataset or pd.DataFrame

      :return cars dataset id
      :rtype : int



   .. py:method:: get_future_cars_dataset_position(future_result)
      :staticmethod:


      Get cars dataset positions for current future result

      :param future_result: future result:
      :type future_result: xr.Dataset or pd.DataFrame

      :return cars dataset id
      :rtype : tuple(int)