options.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 <memory>
 
#include <yuni/yuni.h>
#include <yuni/core/getopt.h>
#include <yuni/core/string.h>
 
#include <antares/optimization-options/options.h>
#include <antares/study/study.h>
 
class Settings final
{
public:
    void reset();
 
    YString studyFolder;
    Yuni::CString<150, false> simulationName;
    std::string commentFile;
 
    Yuni::CString<32, false> simplexOptimRange;
 
    bool ignoreLoadingErrors = false;
    bool ignoreConstraints = false;
 
    bool tsGeneratorsOnly = false;
 
    bool noOutput = false;
    bool displayProgression = false;
 
    Yuni::String PID;
    bool forceZipOutput = false;
    Antares::Solver::Optimization::CmdLineOptimOptions solverOptions;
}; // class Settings
 
std::unique_ptr<Yuni::GetOpt::Parser> CreateParser(Settings& settings,
                                                   Antares::Data::StudyLoadOptions& options);
 
void checkStudyFolder(const std::string& studyFolder);
std::string fixStudyFolder(const std::string& studyFolder);
void printPIDtoDisk(Settings& settings);
void checkAndCorrectSettingsAndOptions(Settings& settings, Data::StudyLoadOptions& options);