Source code for tvb.core.removers_factory

# -*- coding: utf-8 -*-
#
#
# TheVirtualBrain-Framework Package. This package holds all Data Management, and 
# Web-UI helpful to run brain-simulations. To use it, you also need to download
# TheVirtualBrain-Scientific Package (for simulators). See content of the
# documentation-folder for more details. See also http://www.thevirtualbrain.org
#
# (c) 2012-2023, Baycrest Centre for Geriatric Care ("Baycrest") and others
#
# This program is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.  See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with this
# program.  If not, see <http://www.gnu.org/licenses/>.
#
#
#   CITATION:
# When using The Virtual Brain for scientific publications, please cite it as explained here:
# https://www.thevirtualbrain.org/tvb/zwei/neuroscience-publications
#
#
"""
Created on Nov 1, 2011

.. moduleauthor:: Bogdan Neacsa <bogdan.neacsa@codemart.ro>
"""
import typing

from tvb.core.adapters.abcremover import ABCRemover
from tvb.core.neotraits.db import HasTraitsIndex

####### Default factory is empty
FACTORY_DICTIONARY = {}


def get_remover(datatype_index_class):
    # type: (HasTraitsIndex) -> typing.Type[ABCRemover]
    """
    :param datatype_index_class: class of datatype index; to search for a remover class for this.
    """
    if datatype_index_class in FACTORY_DICTIONARY:
        return FACTORY_DICTIONARY[datatype_index_class]
    else:
        return ABCRemover


def update_dictionary(new_dict):
    # type: (dict) -> None
    """
    Update removers dictionary.
    """
    FACTORY_DICTIONARY.update(new_dict)