Antares Simulator
Power System Simulator
FileTreeStudyLoader.h
1 
2 /*
3  * Copyright 2007-2025, RTE (https://www.rte-france.com)
4  * See AUTHORS.txt
5  * SPDX-License-Identifier: MPL-2.0
6  * This file is part of Antares-Simulator,
7  * Adequacy and Performance assessment for interconnected energy networks.
8  *
9  * Antares_Simulator is free software: you can redistribute it and/or modify
10  * it under the terms of the Mozilla Public Licence 2.0 as published by
11  * the Mozilla Foundation, either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * Antares_Simulator is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * Mozilla Public Licence 2.0 for more details.
18  *
19  * You should have received a copy of the Mozilla Public Licence 2.0
20  * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
21  */
22 
23 #pragma once
24 #include <filesystem>
25 
26 #include "antares/study-loader/IStudyLoader.h"
27 
28 namespace Antares
29 {
30 namespace Data
31 {
32 class Study;
33 }
34 
44 {
45 public:
46  explicit FileTreeStudyLoader(std::filesystem::path study_path);
47  ~FileTreeStudyLoader() override = default;
48 
58  [[nodiscard]] std::unique_ptr<Antares::Data::Study> load() const override;
59 
60 private:
61  std::string study_path_;
62 };
63 } // namespace Antares
A class to load studies from the file tree.
Definition: FileTreeStudyLoader.h:44
std::unique_ptr< Antares::Data::Study > load() const override
Loads a study from the file tree.
Definition: FileTreeStudyLoader.cpp:36
The IStudyLoader class is an interface for loading studies.
Definition: IStudyLoader.h:39