cars.orchestrator.registry.replacer_registry
============================================

.. py:module:: cars.orchestrator.registry.replacer_registry

.. autoapi-nested-parse::

   This module contains the replacer registry class



Classes
-------

.. autoapisummary::

   cars.orchestrator.registry.replacer_registry.CarsDatasetRegistryReplacer
   cars.orchestrator.registry.replacer_registry.SingleCarsDatasetReplacer


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

.. py:class:: CarsDatasetRegistryReplacer(id_generator)

   Bases: :py:obj:`cars.orchestrator.registry.abstract_registry.AbstractCarsDatasetRegistry`


   CarsDatasetRegistryReplacer
   This registry manages the replacement of arriving future results
   into corresponding CarsDataset


   .. py:attribute:: registered_cars_datasets_replacers
      :value: []



   .. py:method:: cars_dataset_in_registry(cars_ds)

      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()

      Get a list of registered CarsDataset

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



   .. py:method:: get_cars_ds_replacer_corresponding_id(obj_id)

      Get the SingleCarsDatasetReplacer corresponding to given id

      :param obj_id: cars dataset id
      :type obj_id: int

      :return : single cars dataset replacer
      :rtype : SingleCarsDatasetReplacer



   .. py:method:: replace_lasting_jobs(delayed_type)

      Replace last jobs by Nones



   .. py:method:: get_cars_ds(future_result)

      Get a list of registered CarsDataset

      :param future_result: object to get cars dataset from

      :return corresponding CarsDataset
      :rtype: CarsDataset



   .. py:method:: add_cars_ds_to_replace(cars_ds)

      Add cars dataset to registry

      :param cars_ds: cars dataset
      :type cars_ds: CarsDataset




   .. py:method:: get_corresponding_replacer(future_result)

      Get replacer corresponding to future result

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

      :return replacer
      :rtype: SingleCarsDatasetReplacer



   .. py:method:: replace(future_result)

      Replace future result

      :param future_result: xr.Dataset or pandas.DataFrame or Dict




.. py:class:: SingleCarsDatasetReplacer(cars_ds, obj_id)

   SingleCarsDatasetReplacer

   Manages the replacement of a CarsDataset


   .. py:attribute:: cars_ds


   .. py:attribute:: obj_id


   .. py:attribute:: as_been_seen
      :value: False