load-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/>.
 */
#ifndef __ANTARES_LIBS_SOLVER_LOAD_OPTIONS_H__
#define __ANTARES_LIBS_SOLVER_LOAD_OPTIONS_H__
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
#include <antares/optimization-options/options.h>
 
#include "parameters.h"
 
namespace Antares::Data
{
class StudyLoadOptions final
{
public:
 
    StudyLoadOptions();
 
    void checkForceSimulationMode();
 
public:
    uint nbYears;
    bool prepareOutput;
    bool loadOnlyNeeded;
    bool forceYearByYear;
 
    bool forceDerated;
 
    // This option might be useful for running old studies without upgrading
    bool noTimeseriesImportIntoInput;
 
    SimplexOptimization simplexOptimizationRange;
    bool mpsToExport;
    bool namedProblems = false;
    bool ignoreConstraints;
    SimulationMode forceMode;
 
    bool enableParallel;
 
    bool forceParallel;
    uint maxNbYearsInParallel;
 
    bool usedByTheSolver;
 
    Antares::Solver::Optimization::CmdLineOptimOptions solverOptions;
 
    mutable Yuni::String logMessage;
 
    bool displayVersion = false;
 
    bool listSolvers = false;
 
    bool forceExpansion = false;
    bool forceEconomy = false;
    bool forceAdequacy = false;
 
    YString studyFolder;
    YString simulationName;
}; // class StudyLoadOptions
 
} // namespace Antares::Data
 
#endif // __ANTARES_LIBS_SOLVER_LOAD_OPTIONS_H__