cluster_list.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_PARTS_COMMON_CLUSTER_LIST_H__
#define __ANTARES_LIBS_STUDY_PARTS_COMMON_CLUSTER_LIST_H__
 
#include <algorithm>
#include <memory>
#include <ranges>
#include <vector>
 
#include <antares/logs/logs.h>
#include <antares/writer/i_writer.h>
 
#include "../../fwd.h"
 
namespace Antares::Data
{
 
// TODO VP: remove template, we can have a regular class in this use case
template<class ClusterT>
class ClusterList
{
public:
    using SharedPtr = typename std::shared_ptr<ClusterT>;
 
    void clearAll();
    bool empty() const;
 
    ClusterT* findInAll(std::string_view id) const;
 
    bool exists(const std::string& id) const;
 
    auto each_enabled() const
    {
        return allClusters_ | std::views::filter(&ClusterT::isEnabled);
    }
 
    std::vector<std::shared_ptr<ClusterT>> all() const;
 
    bool rename(std::string idToFind, std::string newName);
 
    virtual bool remove(const std::string& id);
 
 
    SharedPtr operator[](std::size_t idx)
    {
        return allClusters_[idx];
    }
 
    SharedPtr operator[](std::size_t idx) const
    {
        return allClusters_[idx];
    }
 
    SharedPtr enabledClusterAt(unsigned int index) const;
    void resizeAllTimeseriesNumbers(uint n) const;
 
    void storeTimeseriesNumbers(Solver::IResultWriter& writer) const;
 
 
    bool forceReload(bool reload = false) const;
 
    void markAsModified() const;
 
    bool loadDataSeriesFromFolder(Study& study, const std::filesystem::path& folder);
 
    bool saveDataSeriesToFolder(const AnyString& folder) const;
#ifdef BUILD_UI
    virtual bool saveToFolder(const AnyString& folder) const = 0;
#endif
 
    void retrieveTotalCapacityAndUnitCount(double& total, uint& unitCount) const;
 
    unsigned int enabledCount() const;
    unsigned int allClustersCount() const;
    void addToCompleteList(std::shared_ptr<ClusterT> cluster);
    void sortCompleteList();
 
protected:
    std::vector<std::shared_ptr<ClusterT>> allClusters_;
 
    virtual std::string typeID() const = 0;
 
    // Give a special index to enabled clusters (thermal / renewable)
    void rebuildIndexes();
 
private:
    bool alreadyInAllClusters(std::string clusterName);
 
}; // class ClusterList
} // namespace Antares::Data
#endif /* __ANTARES_LIBS_STUDY_PARTS_COMMON_CLUSTER_LIST_H__ */