context.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_STUDY_ACTION_CONTEXT_H__
#define __ANTARES_LIBS_STUDY_ACTION_CONTEXT_H__
 
#include <yuni/yuni.h>
#include <antares/study/study.h>
#include <map>
#include <yuni/core/string.h>
#include <yuni/core/bind.h>
#include <memory>
#include "action.h"
#include <antares/study/binding_constraint/BindingConstraintsRepository.h>
 
namespace Antares::Action
{
class Context
{
public:
    using Ptr = std::shared_ptr<Context>;
    using Properties = std::map<Yuni::String, Yuni::String>;
    using LocalView = std::map<Yuni::CString<50, false>, IAction::Ptr>;
    using Views = std::map<Yuni::CString<50, false>, LocalView>;
 
    using AreaNameMappingForceCreate = std::map<Data::AreaName, bool>;
    using PlantNameMappingForceCreate = std::map<Data::AreaName, bool>;
    using ConstraintMappingForceCreate = std::map<Data::ConstraintName, bool>;
 
public:
 
    explicit Context(Data::Study::Ptr targetStudy, const size_t layer = 0);
    ~Context() = default;
 
    void reset();
 
public:
    Data::Study::Ptr study;
    Data::Study::Ptr extStudy;
 
    // The current Layer
    const size_t layerID;
 
    Data::Area* area;
    Data::ThermalCluster* cluster;
    Data::AreaLink* link;
    Data::ThermalCluster* originalPlant;
    std::shared_ptr<Data::BindingConstraint> constraint;
 
    Views view;
    Properties property;
 
    Data::Area::NameMapping areaNameMapping;
    Data::Area::NameMapping areaLowerNameMapping;
    AreaNameMappingForceCreate areaForceCreate;
    PlantNameMappingForceCreate clusterForceCreate;
    ConstraintMappingForceCreate constraintForceCreate;
 
    Yuni::String message;
    Yuni::Bind<void(const Yuni::String&)> updateMessageUI;
 
 
    Data::Area::Vector autoselectAreas;
    Data::AreaLink::Vector autoselectLinks;
    Data::BindingConstraintsRepository::Vector autoselectConstraints;
 
}; // class Context
 
} // namespace Antares::Action
 
#endif // __ANTARES_LIBS_STUDY_ACTION_CONTEXT_H__