Source code for gemseo.algos.progress_bar_data.factory

# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
"""Factory of classes for displaying data in progress bars."""

from __future__ import annotations

from typing import Final

from strenum import StrEnum

from gemseo.algos.progress_bar_data.base import BaseProgressBarData
from gemseo.core.base_factory import BaseFactory




class ProgressBarDataFactory(BaseFactory):
    """The factory for ``BaseProgressBarData`` objects."""

    _CLASS = BaseProgressBarData
    _PACKAGE_NAMES = ("gemseo.algos.progress_bar_data",)



PROGRESS_BAR_DATA_FACTORY: Final[ProgressBarDataFactory] = ProgressBarDataFactory()
"""The factory for ``BaseProgressBarData`` objects."""

ProgressBarDataName = StrEnum(
    "ProgressBarDataName", names=PROGRESS_BAR_DATA_FACTORY.class_names
)
"""A name of a :class:`.BaseProgressBarData` subclass."""