NTCTSNumberData.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/>.
*/
//
// Created by marechaljas on 03/07/23.
//
 
#pragma once
#include "TSnumberData.h"
 
namespace Antares::Data::ScenarioBuilder
{
class ntcTSNumberData final: public TSNumberData
{
public:
    ntcTSNumberData() = default;
    virtual ~ntcTSNumberData() = default;
 
    bool reset(const Study& study) override;
#ifdef BUILD_UI
    void saveToINIFile(const Study& study, Yuni::IO::File::Stream& file) const override;
#endif
 
    void attachArea(const Area* area)
    {
        pArea = area;
    }
 
    void setTSnumber(const Antares::Data::AreaLink* link, const uint year, uint value);
    uint get(const Antares::Data::AreaLink* link, const uint year) const;
    bool apply(Study& study) override;
    CString<512, false> get_prefix() const override;
    uint get_tsGenCount(const Study& study) const override;
 
private:
    const Area* pArea = nullptr;
};
 
inline uint ntcTSNumberData::get(const Antares::Data::AreaLink* link, const uint year) const
{
    assert(link != nullptr);
    if (year < pTSNumberRules.height && link->indexForArea < pTSNumberRules.width)
    {
        const uint index = link->indexForArea;
        return pTSNumberRules[index][year];
    }
    return 0;
}
 
inline CString<512, false> ntcTSNumberData::get_prefix() const
{
    return "ntc,";
}
} // namespace Antares::Data::ScenarioBuilder