rules.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 __LIBS_STUDY_SCENARIO_BUILDER_RULES_H__
#define __LIBS_STUDY_SCENARIO_BUILDER_RULES_H__
 
#include <map>
#include <memory>
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
#include "../fwd.h"
#include "BindingConstraintsTSNumbersData.h"
#include "HydroTSNumberData.h"
#include "LoadTSNumberData.h"
#include "NTCTSNumberData.h"
#include "RenewableTSNumberData.h"
#include "ShortTermAdditionalConstraintsTSNumberData.h"
#include "ShortTermInflowsTSNumberData.h"
#include "TSnumberData.h"
#include "ThermalTSNumberData.h"
#include "WindTSNumberData.h"
#include "hydroLevelsData.h"
#include "solarTSNumberData.h"
 
namespace Antares::Data::ScenarioBuilder
{
class Rules final: private Yuni::NonCopyable<Rules>
{
public:
    using Ptr = std::shared_ptr<Rules>;
    using Map = std::map<RulesScenarioName, Ptr>;
    using MappingID = std::map<int, Ptr>;
 
 
 
    explicit Rules(Study& study);
    ~Rules() = default;
 
 
 
    bool reset();
 
    bool readLine(const AreaName::Vector& splitKey, const String& value, bool updaterMode = false);
 
#ifdef BUILD_UI
    void saveToINIFile(Yuni::IO::File::Stream& file) const;
#endif
 
    uint areaCount() const;
 
    const RulesScenarioName& name() const;
    void setName(RulesScenarioName name);
 
    bool apply();
 
    // When current rule is the active one, sends warnings for disabled clusters.
    void sendWarningsForDisabledClusters();
 
    loadTSNumberData load;
    solarTSNumberData solar;
    hydroTSNumberData hydro;
    windTSNumberData wind;
 
    std::vector<thermalTSNumberData> thermal;
    std::vector<renewableTSNumberData> renewable;
 
    hydroLevelsData hydroInitialLevels = {"hl,", initLevelApply};
    hydroLevelsData hydroFinalLevels = {"hfl,", finalLevelApply};
 
    // Links NTC
    std::vector<ntcTSNumberData> linksNTC;
 
    BindingConstraintsTSNumberData binding_constraints;
 
    std::vector<ShortTermInflowsTSNumberData> shortTermStorageInflows;
    std::vector<ShortTermAdditionalConstraintsTSNumberData> shortTermStorageAdditionalConstraints;
 
private:
    // Member methods
    bool readThermalCluster(const AreaName::Vector& instrs, const String& value, bool updaterMode);
    bool readRenewableCluster(const AreaName::Vector& instrs,
                              const String& value,
                              bool updaterMode);
    bool readLoad(const AreaName::Vector& instrs, const String& value, bool updaterMode);
    bool readWind(const AreaName::Vector& instrs, const String& value, bool updaterMode);
    bool readHydro(const AreaName::Vector& instrs, const String& value, bool updaterMode);
    bool readSolar(const AreaName::Vector& instrs, const String& value, bool updaterMode);
    bool readInitialHydroLevels(const AreaName::Vector& instrs,
                                const String& value,
                                bool updaterMode);
    bool readFinalHydroLevels(const AreaName::Vector& instrs,
                              const String& value,
                              bool updaterMode);
    bool readLink(const AreaName::Vector& instrs, const String& value, bool updaterMode);
    bool readBindingConstraints(const AreaName::Vector& splitKey, const String& value);
 
    bool readShortTermStorageInflows(const AreaName::Vector& splitKey,
                                     const String& value,
                                     bool updaterMode);
 
    bool readShortTermStorageAdditionalConstraints(const AreaName::Vector& splitKey,
                                                   const String& value,
                                                   bool updaterMode);
 
    Data::Area* getArea(const AreaName& areaname, bool updaterMode);
    Data::AreaLink* getLink(const AreaName& fromAreaName,
                            const AreaName& toAreaName,
                            bool updaterMode);
    bool checkGroupExists(const std::string& groupName) const;
 
    // Member data
    Study& study_;
    uint pAreaCount;
    RulesScenarioName pName;
    // Disabled clusters when current rule is active (useful for sending warnings)
    std::map<std::string, std::vector<uint>> disabledClustersOnRuleActive;
 
}; // class Rules
 
} // namespace Antares::Data::ScenarioBuilder
 
#include "rules.hxx"
 
#endif // __LIBS_STUDY_SCENARIO_BUILDER_RULES_H__