Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
API.h
1/*
2 * Copyright 2007-2024, 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
25#include <antares/optimization-options/options.h>
26#include <antares/study-loader/IStudyLoader.h>
27#include "antares/api/SimulationResults.h"
28
29namespace Antares::Data
30{
31class Study;
32}
33
34namespace Antares::API
35{
36
42{
43public:
50 SimulationResults run(const IStudyLoader& study_loader,
51 const std::filesystem::path& output,
53
54private:
55 std::shared_ptr<Antares::Data::Study> study_;
56 SimulationResults execute(
57 const std::filesystem::path& output,
59};
60
61} // namespace Antares::API
The APIInternal class is used to run simulations.
Definition API.h:42
SimulationResults run(const IStudyLoader &study_loader, const std::filesystem::path &output, const Antares::Solver::Optimization::OptimizationOptions &optOptions)
The run method is used to run the simulation.
Definition API.cpp:35
The IStudyLoader class is an interface for loading studies.
Definition IStudyLoader.h:39
The SimulationResults structure is used to represent the results of a simulation.
Definition SimulationResults.h:49