Antares Simulator
Power System Simulator
SimulationResults.h
1 /*
2  * Copyright 2007-2025, RTE (https://www.rte-france.com)
3  * See AUTHORS.txt
4  * SPDX-License-Identifier: MPL-2.0
5  * This file is part of Antares-Simulator,
6  * Adequacy and Performance assessment for interconnected energy networks.
7  *
8  * Antares_Simulator is free software: you can redistribute it and/or modify
9  * it under the terms of the Mozilla Public Licence 2.0 as published by
10  * the Mozilla Foundation, either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * Antares_Simulator is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * Mozilla Public Licence 2.0 for more details.
17  *
18  * You should have received a copy of the Mozilla Public Licence 2.0
19  * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20  */
21 
22 #pragma once
23 #include <filesystem>
24 #include <optional>
25 #include <string>
26 
27 #include "antares/solver/lps/LpsFromAntares.h"
28 
29 namespace Antares::API
30 {
35 struct Error
36 {
40  std::string reason;
41 };
42 
48 struct [[nodiscard("Contains results and potential error")]] SimulationResults
49 {
57  std::optional<Error> error;
58 };
59 
60 } // namespace Antares::API
The LpsFromAntares class is used to manage the constant and weekly data for Antares problems.
Definition: LpsFromAntares.h:113
The Error structure is used to represent an error that occurred during the simulation.
Definition: SimulationResults.h:36
std::string reason
The reason for the error.
Definition: SimulationResults.h:40
The SimulationResults structure is used to represent the results of a simulation.
Definition: SimulationResults.h:49
Antares::Solver::LpsFromAntares antares_problems
weekly problems
Definition: SimulationResults.h:53
std::optional< Error > error
An optional error that occurred during the simulation.
Definition: SimulationResults.h:57