singleProblemGetter.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator 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
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
 
#pragma once
 
#include <filesystem>
#include <memory>
 
#include "antares/solver/lps/LpsFromAntares.h"
#include "antares/study/study.h"
 
namespace Antares::Solver::Implementation
{
class SingleProblemGetter;
}
 
namespace Antares::Solver
{
class SingleProblemGetter final
{
public:
    explicit SingleProblemGetter(const std::filesystem::path& studyPath);
    ~SingleProblemGetter();
    // NOTE week indices start at 1
    // year indices start at 0
    std::vector<WeeklyProblemId> getProblemIds() const;
    ConstantDataFromAntares getConstantData();
    // NOTE week indices start at 1
    // year indices start at 0
    WeeklyDataFromAntares getWeeklyData(WeeklyProblemId id);
 
    // TODO[FOM] This should not be necessary
    void writeNTCTimeSeries(const std::filesystem::path& outputDir);
    void writeStudyDescriptionFiles(const std::filesystem::path& outputDir);
 
private:
    std::unique_ptr<Implementation::SingleProblemGetter> impl_;
};
} // namespace Antares::Solver