xcast.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_XCAST_XCAST_H__
#define __ANTARES_LIBS_STUDY_XCAST_XCAST_H__
 
#include <vector>
 
#include <yuni/yuni.h>
#include <yuni/core/noncopyable.h>
 
#include <antares/array/matrix.h>
#include <antares/study/fwd.h>
 
namespace Antares::Data
{
class XCast final: private Yuni::NonCopyable<XCast>
{
public:
    using Vector = std::vector<XCast*>;
    using VectorConst = std::vector<const XCast*>;
 
    enum
    {
        dataCoeffAlpha = 0,
        dataCoeffBeta,
        dataCoeffGamma,
        dataCoeffDelta,
        dataCoeffTheta,
        dataCoeffMu,
        dataMax,
    };
 
    enum Distribution
    {
        dtNone = 0,
        dtUniform = 1,
        dtBeta = 2,
        dtNormal = 3,
        dtWeibullShapeA = 4,
        dtGammaShapeA = 5,
        dtMax
    };
 
    enum
    {
        conversionMaxPoints = 100,
    };
 
    enum TSTranslationUse
    {
        tsTranslationNone = 0,
        tsTranslationBeforeConversion,
        tsTranslationAfterConversion,
    };
 
public:
    static const char* DistributionToCString(Distribution d);
 
    static Distribution StringToDistribution(AnyString str);
 
    static const char* DistributionToNameID(Distribution d);
 
    static const char* TSTranslationUseToCString(TSTranslationUse use);
 
    static TSTranslationUse CStringToTSTranslationUse(const AnyString& str);
 
public:
 
 
    XCast(TimeSeriesType ts);
    ~XCast();
 
    void resetToDefaultValues();
 
    void copyFrom(const XCast& rhs);
 
    bool loadFromFolder(const std::filesystem::path& folder);
 
    bool saveToFolder(const AnyString& folder) const;
 
 
 
    bool forceReload(bool reload = false) const;
 
    void markAsModified() const;
 
public:
    Matrix<float> data;
 
    Matrix<float> K;
 
    Matrix<int32_t> translation;
 
    TSTranslationUse useTranslation;
 
    Distribution distribution;
 
    double capacity;
 
    bool useConversion;
    Matrix<float> conversion;
 
    const TimeSeriesType timeSeries;
 
protected:
    void resetTransferFunction();
 
}; // class XCast
 
} // namespace Antares::Data
 
#endif // __ANTARES_LIBS_STUDY_XCAST_XCAST_H__