links.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_LINKS_H__
#define __ANTARES_LIBS_STUDY_LINKS_H__
 
#include <set>
 
#include <yuni/yuni.h>
#include <yuni/core/noncopyable.h>
#include <yuni/core/string.h>
 
#include <antares/array/matrix.h>
#include <antares/exception/LoadingError.hpp>
#include <antares/series/series.h>
#include <antares/solver/ts-generator/prepro.h>
#include <antares/study/version.h>
#include <antares/writer/i_writer.h>
 
#include "../fwd.h"
 
namespace Antares::Error
{
class ReadingStudy final: public LoadingError
{
public:
    ReadingStudy();
};
} // namespace Antares::Error
 
namespace Antares::Data
{
struct CompareLinkName;
 
class AreaLink final: public Yuni::NonCopyable<AreaLink>
{
public:
    using Vector = std::vector<AreaLink*>;
    using Set = std::set<AreaLink*, CompareLinkName>;
    using Map = std::map<AreaName, AreaLink*>;
 
    using NamePair = std::pair<Yuni::String, Yuni::String>;
 
public:
 
 
    AreaLink();
    ~AreaLink();
 
    bool loadTimeSeries(const StudyVersion& version, const std::filesystem::path& folder);
 
    void storeTimeseriesNumbers(Solver::IResultWriter& writer) const;
 
 
 
    void detach();
 
 
 
    void reverse();
 
    void resetToDefaultValues();
 
    bool forceReload(bool reload = false) const;
 
    void markAsModified() const;
 
    bool isVisibleOnLayer(const size_t& layerID) const;
 
    Yuni::String getName() const;
 
    bool isLinkPhysical() const;
    void overrideTransmissionCapacityAccordingToGlobalParameter(GlobalTransmissionCapacities tc);
 
private:
    bool linkLoadTimeSeries_for_version_below_810(const std::filesystem::path& folder);
    bool linkLoadTimeSeries_for_version_820_and_later(const std::filesystem::path& folder);
    NamePair getNamePair() const;
 
public:
 
    Area* from;
    Area* with;
 
    TimeSeriesNumbers timeseriesNumbers;
 
 
 
    Matrix<> parameters;
    TimeSeries directCapacities;
    TimeSeries indirectCapacities;
 
    bool useLoopFlow;
 
    bool usePST;
 
    bool useHurdlesCost;
 
    // previously called copper plate
    LocalTransmissionCapacities transmissionCapacities;
 
    AssetType assetType;
 
 
 
    uint index;
    uint indexForArea;
 
 
    Yuni::String comments;
    bool displayComments;
 
 
    uint filterSynthesis;
    uint filterYearByYear;
 
    int color[3];
    StyleType style;
    int linkWidth;
 
    friend struct CompareLinkName;
}; // class AreaLink
 
struct CompareLinkName final
{
    inline bool operator()(const AreaLink* s1, const AreaLink* s2) const
    {
        return s1->getNamePair() < s2->getNamePair();
    }
};
 
} // namespace Antares::Data
 
#endif // __ANTARES_LIBS_STUDY_LINKS_H__