consolidationaudit2d.h

Go to the documentation of this file.

/**
 * @file consolidationaudit2d.h
 * @brief Declares cross-cutting static consistency checks for all guided QPE presets.
 * @ingroup qpe_experiments
 *
 * Source: @c core/experiments/consolidationaudit2d.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
 
#include <string>
#include <vector>
 
namespace qpe {
 
/**
 * @brief Enumerates the supported Consolidation Audit Status2D values.
 *
 * The enumeration is part of the typed interface used to keep experiment configuration and analysis routing explicit.
 */
enum class ConsolidationAuditStatus2D
{
    Pass,
    Warning,
    Fail
};
 
/**
 * @brief Data structure used by the Consolidation Preset Audit2D component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct ConsolidationPresetAudit2D
{
    int presetIndex = -1;
    ConsolidationAuditStatus2D status = ConsolidationAuditStatus2D::Fail;
    std::string presetName;
    std::string helpId;
    std::string analysisPageId;
    std::string message;
};
 
/**
 * @brief Data structure used by the Consolidation Audit Summary2D component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct ConsolidationAuditSummary2D
{
    int passCount = 0;
    int warningCount = 0;
    int failCount = 0;
    std::vector<ConsolidationPresetAudit2D> presets;
 
    /**
     * @brief Carries out ok.
     */
    bool ok() const noexcept { return failCount == 0; }
};
 
/**
 * @brief Static cross-cutting audit for the frozen guided experiment catalog.
 *
 * The audit checks catalog alignment, unique identifiers, finite/legal parameters, Analysis routing, Help coverage, potential scenes, and representative physical scales before release.
 */
class ConsolidationAudit2D
{
public:
    /**
     * @brief Performs audit guided presets.
     */
    static ConsolidationAuditSummary2D auditGuidedPresets();
    /**
     * @brief Performs status name.
     * @param status The status value used by the operation.
     */
    static const char *statusName(ConsolidationAuditStatus2D status) noexcept;
};
 
} // namespace qpe