endoflist.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_END_OF_LIST_END_OF_LIST_H__
#define __SOLVER_END_OF_LIST_END_OF_LIST_H__
 
#include <yuni/yuni.h>
 
#include <antares/study/study.h>
 
#include "state.h"
#include "surveyresults.h"
 
// To remove warnings (unused variable) at compile time on linux
#define UNUSED_VARIABLE(x) (void)(x)
 
namespace Antares::Solver::Variable::Container
{
class EndOfList
{
public:
    typedef void NextType;
 
    enum
    {
        count = 0,
    };
 
    template<int CategoryDataLevel, int CategoryFile>
    struct Statistics
    {
        enum
        {
            count = 0
        };
    };
 
public:
    template<class PredicateT>
    static void RetrieveVariableList(PredicateT&)
    {
    }
 
public:
 
    EndOfList()
    {
    }
 
    ~EndOfList()
    {
    }
 
 
    static void initializeFromStudy([[maybe_unused]] Data::Study& study)
    {
    }
 
    static void initializeFromArea(Data::Study*, Data::Area*)
    {
    }
 
    static void initializeFromThermalCluster(Data::Study*, Data::Area*, Data::ThermalCluster*)
    {
    }
 
    static void initializeFromAreaLink(Data::Study*, Data::AreaLink*)
    {
    }
 
    void broadcastNonApplicability(bool)
    {
    }
 
    void getPrintStatusFromStudy([[maybe_unused]] Data::Study& study)
    {
    }
 
    void supplyMaxNumberOfColumns([[maybe_unused]] Data::Study& study)
    {
    }
 
    static void simulationBegin()
    {
    }
 
    static void simulationEnd()
    {
    }
 
    static void yearBegin(unsigned int, unsigned int)
    {
    }
 
    static void yearEndBuildPrepareDataForEachThermalCluster(State& state, uint year, uint numSpace)
    {
        UNUSED_VARIABLE(state);
        UNUSED_VARIABLE(year);
        UNUSED_VARIABLE(numSpace);
    }
 
    static void yearEndBuildForEachThermalCluster(State& state, uint year, uint numSpace)
    {
        UNUSED_VARIABLE(state);
        UNUSED_VARIABLE(year);
        UNUSED_VARIABLE(numSpace);
    }
 
    static void yearEndBuild(State&, unsigned int, unsigned int)
    {
    }
 
    static void yearEnd(unsigned int, unsigned int)
    {
    }
 
    static void computeSummary(unsigned int year, unsigned int numSpace)
    {
        UNUSED_VARIABLE(year);
        UNUSED_VARIABLE(numSpace);
    }
 
    template<class V>
    void yearEndSpatialAggregates(V&, unsigned int, uint)
    {
    }
 
    template<class V, class SetT>
    void yearEndSpatialAggregates(V&, unsigned int, const SetT&, uint numSpace)
    {
        UNUSED_VARIABLE(numSpace);
    }
 
    template<class V>
    static void computeSpatialAggregatesSummary(V&, unsigned int, unsigned int)
    {
    }
 
    template<class V>
    static void simulationEndSpatialAggregates(V&)
    {
    }
 
    template<class V, class SetT>
    void simulationEndSpatialAggregates(V&, const SetT&)
    {
    }
 
    static void weekBegin(State&)
    {
    }
 
    static void weekForEachArea(State&, uint numSpace)
    {
        UNUSED_VARIABLE(numSpace);
    }
 
    static void weekEnd(State&)
    {
    }
 
    static void hourBegin(unsigned int)
    {
    }
 
    static void hourForEachArea(State&, uint numSpace)
    {
        UNUSED_VARIABLE(numSpace);
    }
 
    static void hourForEachLink(State&, uint numSpace)
    {
        UNUSED_VARIABLE(numSpace);
    }
 
    static void hourEnd(State&, unsigned int)
    {
    }
 
    static void buildSurveyReport(SurveyResults&, int, int, int)
    {
    }
 
    static void buildAnnualSurveyReport(SurveyResults&, int, int, int, uint)
    {
    }
 
    static void buildDigest(SurveyResults&, int, int)
    {
    }
 
    static void beforeYearByYearExport(uint /*year*/, uint)
    {
    }
 
    template<class I>
    static void provideInformations(I&)
    {
    }
 
    template<class SearchVCardT, class O>
    static void computeSpatialAggregateWith(O&)
    {
        assert(false);
    }
 
    template<class SearchVCardT, class O>
    static void computeSpatialAggregateWith(O&, const Data::Area*)
    {
        assert(false);
    }
 
    template<class SearchVCardT, class O>
    static void computeSpatialAggregateWith(O&, const Data::Area*, uint numSpace)
    {
        UNUSED_VARIABLE(numSpace);
    }
 
    template<class VCardToFindT>
    const double* retrieveHourlyResultsForCurrentYear(uint) const
    {
        return nullptr;
    }
 
    template<class VCardToFindT, class O>
    static void retrieveResultsForArea(O** /*result*/, const Data::Area*)
    {
        // Does nothing - this method may be called from a leaf
        // Consequently we can not throw an error from here if the variable `result`
        // is not initialized.
    }
 
    template<class VCardToFindT, class O>
    static void retrieveResultsForThermalCluster(O** /*result*/, const Data::ThermalCluster*)
    {
        // Does nothing - this method may be called from a leaf
        // Consequently we can not throw an error from here if the variable `result`
        // is not initialized.
    }
 
    template<class VCardToFindT, class O>
    static void retrieveResultsForLink(O** /*result*/, const Data::AreaLink*)
    {
        // Does nothing - this method may be called from a leaf
        // Consequently we can not throw an error from here if the variable `result`
        // is not initialized.
    }
 
    void localBuildAnnualSurveyReport(SurveyResults&, int, int, unsigned int) const
    {
        // Does nothing
    }
 
}; // class EndOfList
 
} // namespace Antares::Solver::Variable::Container
 
#endif // __SOLVER_END_OF_LIST_END_OF_LIST_H__