BindingConstraintsRepository.h

/*
** Copyright 2007-2024, 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/>.
*/
//
// Created by marechaljas on 11/05/23.
//
 
#pragma once
 
#include <functional>
#include <memory>
 
#include "BindingConstraint.h"
#include "BindingConstraintSaver.h"
 
namespace Antares::Data
{
class BindingConstraintsRepository final: public Yuni::NonCopyable<BindingConstraintsRepository>
{
public:
    using Vector = std::vector<std::shared_ptr<BindingConstraint>>;
    using Set = std::set<std::shared_ptr<BindingConstraint>, CompareBindingConstraintName>;
 
    using iterator = Vector::iterator;
    using const_iterator = Vector::const_iterator;
 
 
 
    BindingConstraintsRepository() = default;
    ~BindingConstraintsRepository() = default;
 
    void clear();
 
 
 
    template<class PredicateT>
    void each(const PredicateT& predicate);
    template<class PredicateT>
    void each(const PredicateT& predicate) const;
 
    iterator begin();
    [[nodiscard]] const_iterator begin() const;
 
    iterator end();
    [[nodiscard]] const_iterator end() const;
 
    [[nodiscard]] bool empty() const;
 
    std::shared_ptr<BindingConstraint> add(const AnyString& name);
 
    std::shared_ptr<Data::BindingConstraint> find(const AnyString& id);
 
    [[nodiscard]] std::shared_ptr<const Data::BindingConstraint> find(const AnyString& id) const;
 
    [[nodiscard]] Data::BindingConstraint* findByName(const AnyString& name);
 
    [[nodiscard]] const Data::BindingConstraint* findByName(const AnyString& name) const;
 
    [[nodiscard]] bool loadFromFolder(Data::Study& s,
                                      const Data::StudyLoadOptions& options,
                                      const std::filesystem::path& folder);
 
    [[nodiscard]] bool saveToFolder(const AnyString& folder) const;
 
    void reverseWeightSign(const Data::AreaLink* lnk);
 
    [[nodiscard]] uint size() const;
 
    void remove(const Data::BindingConstraint* bc);
    void remove(const Data::Area* area);
    void remove(const Data::AreaLink* area);
 
    void removeConstraintsWhoseNameConstains(const AnyString& filter);
 
    bool rename(Data::BindingConstraint* bc, const AnyString& newname);
 
    void changeConstraintsWeeklyToDaily();
 
    void forceReload(bool reload = false) const;
 
    void markAsModified() const;
 
    static std::vector<std::shared_ptr<BindingConstraint>> LoadBindingConstraint(EnvForLoading env);
 
    [[nodiscard]] std::vector<std::shared_ptr<BindingConstraint>> activeConstraints() const;
 
    [[nodiscard]] Vector getPtrForInequalityBindingConstraints() const;
 
private:
    bool internalSaveToFolder(Data::BindingConstraintSaver::EnvForSaving& env) const;
 
    Data::BindingConstraintsRepository::Vector constraints_;
 
    mutable std::vector<std::shared_ptr<BindingConstraint>> activeConstraints_;
};
 
struct WhoseNameContains final
{
public:
    explicit WhoseNameContains(AnyString filter):
        pFilter(std::move(filter))
    {
    }
 
    bool operator()(const std::shared_ptr<BindingConstraint>& s) const
    {
        return (s->name()).contains(pFilter);
    }
 
private:
    AnyString pFilter;
};
} // namespace Antares::Data
 
#include "BindingConstraintsRepository.hxx"