analysispage2d.h

Go to the documentation of this file.

/**
 * @file analysispage2d.h
 * @brief Declares stable identifiers for experiment-specific Analysis pages.
 * @ingroup qpe_experiments
 *
 * Source: @c core/experiments/analysispage2d.h. This file is part of Quantum Phenomena Explorer (QPE),
 * maintained by Officina Turini. See LICENSE_IT.txt / LICENSE.txt for the
 * QPE freeware source-available terms and THIRD_PARTY_NOTICES.txt for
 * third-party components.
 */
 
#pragma once
 
namespace qpe {
 
// Stable semantic destination for the Analysis dock.  The enum deliberately
// does not contain QWidget/QObject types so preset routing remains testable in
// pure C++14 without Qt GUI dependencies.
/**
 * @brief Enumerates the supported Analysis Page2D values.
 *
 * The enumeration is part of the typed interface used to keep experiment configuration and analysis routing explicit.
 */
enum class AnalysisPage2D
{
    TimeSeries,
    Resonance,
    BoundStates,
    DoubleWell,
    Quench,
    PeriodicDrive,
    Rabi,
    LandauZener,
    Stueckelberg,
    Ramsey,
    Bloch,
    Revivals,
    Billiards,
    Talbot,
    Bouncer,
    Vortex,
    Anderson,
    KickedRotor,
    Zeno,
    Scars,
    BerryPhase,
    Loschmidt,
    Moshinsky,
    KapitzaDirac,
    AharonovBohm,
    Landau,
    HallEdge,
    Backflow,
    Zitterbewegung,
    Klein,
    KleinAngleScan,
    KleinHeightScan,
    KleinMassScan,
    MasslessDirac,
    Unknown
};
 
/**
 * @brief Central catalog mapping guided presets to Analysis pages.
 *
 * Keeping this mapping outside MainWindow avoids scattered preset-index conditionals and makes routing independently testable.
 */
class AnalysisPageCatalog2D
{
public:
    /**
     * @brief Performs preset count.
     */
    static int presetCount() noexcept;
    /**
     * @brief Returns whether valid preset.
     * @param presetIndex Zero-based guided-preset index.
     */
    static bool isValidPreset(int presetIndex) noexcept;
    /**
     * @brief Performs page for preset.
     * @param presetIndex Zero-based guided-preset index.
     */
    static AnalysisPage2D pageForPreset(int presetIndex) noexcept;
    /**
     * @brief Performs page id.
     * @param page The page value used by the operation.
     */
    static const char *pageId(AnalysisPage2D page) noexcept;
};
 
} // namespace qpe