surveyresults.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 __SOLVER_VARIABLE_SURVEY_RESULTS_SURVEY_RESULTS_H__
#define __SOLVER_VARIABLE_SURVEY_RESULTS_SURVEY_RESULTS_H__
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
#include <antares/study/study.h>
#include <antares/study/variable-print-info.h>
#include <antares/writer/i_writer.h>
#include "antares/antares/constants.h"
 
#include "../categories.h"
#include "data.h"
 
namespace Antares::Solver::Variable
{
class SurveyResults
{
public:
    typedef Yuni::CString<10, false> PrecisionType;
    typedef Yuni::CString<128, false> CaptionType;
 
public:
 
 
    SurveyResults(const Data::Study& s, const Yuni::String& o, IResultWriter& writer);
    ~SurveyResults();
 
    void saveToFile(int dataLevel, int fileLevel, int precisionLevel);
 
    void exportGridInfos();
 
    // Reset a line of values to zero.
    void resetValuesAtLine(uint);
 
    void exportDigestAllYears(std::string& buffer);
 
    void exportDigestMatrix(const char* title, std::string& buffer);
 
public:
    Solver::Variable::Private::SurveyResultsData data;
 
    CaptionType variableCaption;
    std::string variableUnit;
 
    double** values;
 
    enum
    {
        captionCount = 3,
    };
 
    CaptionType* captions[captionCount];
 
    PrecisionType* precision;
 
    bool* nonApplicableStatus;
    // Digest file non applicable status ( dim : nb vars x max(nb areas, nb sets of areas) )
    uint digestSize; // Useful dimension for digest file non applicable statut management.
    bool** digestNonApplicableStatus;
 
    uint maxVariables;
 
    bool yearByYearResults;
 
    bool* isCurrentVarNA;
    bool* isPrinted;
    // File writer
    IResultWriter& pResultWriter;
 
private:
    template<class StringT, class ConvertT, class PrecisionT>
    void AppendDoubleValue(uint& error,
                           const double v,
                           StringT& buffer,
                           ConvertT& conversionBuffer,
                           const PrecisionT& precision,
                           const bool isNotApplicable);
 
    void writeDateToFileDescriptor(uint row, int precisionLevel);
 
}; // class SurveyResults
 
} // namespace Antares::Solver::Variable
 
#endif // __SOLVER_VARIABLE_SURVEY_RESULTS_SURVEY_RESULTS_H__