Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
options.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#ifndef __SOLVER_MISC_GETOPT_H__
22#define __SOLVER_MISC_GETOPT_H__
23
24#include <memory>
25
26#include <yuni/yuni.h>
27#include <yuni/core/getopt.h>
28#include <yuni/core/string.h>
29
30#include <antares/optimization-options/options.h>
31#include <antares/study/study.h>
32
37{
38public:
39 void checkAndSetStudyFolder(const std::string& folder);
40 void reset();
41
43 YString studyFolder;
45 Yuni::CString<150, false> simulationName;
47 std::string commentFile;
48
50 Yuni::CString<32, false> simplexOptimRange;
51
55 bool ignoreConstraints = false;
56
58 bool tsGeneratorsOnly = false;
59
61 bool noOutput = false;
63 bool displayProgression = false;
64
65 Yuni::String PID;
66 bool forceZipOutput = false;
68}; // class Settings
69
73std::unique_ptr<Yuni::GetOpt::Parser> CreateParser(Settings& settings,
75
76void checkAndCorrectSettingsAndOptions(Settings& settings, Data::StudyLoadOptions& options);
77
78void checkOrtoolsSolver(const Antares::Solver::Optimization::OptimizationOptions& optOptions);
79#endif /* __SOLVER_MISC_GETOPT_H__ */
Definition load-options.h:36
Command line settings for launching the simulation.
Definition options.h:37
std::string commentFile
Comment file.
Definition options.h:47
Yuni::CString< 150, false > simulationName
Name of the simulation.
Definition options.h:45
Yuni::CString< 32, false > simplexOptimRange
Simplex optimizatio range.
Definition options.h:50
bool tsGeneratorsOnly
Run the TS generator only.
Definition options.h:58
bool noOutput
True to disable the writing in the output folder.
Definition options.h:61
bool displayProgression
Progression.
Definition options.h:63
int ignoreWarningsErrors
Ignore error/warnings.
Definition options.h:53
YString studyFolder
Where is my study.
Definition options.h:43
bool ignoreConstraints
Ignore constraints.
Definition options.h:55