IWriter.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/>.
 
#pragma once
 
#include "data.h"
 
namespace Antares::Optimization
{
class VariableDictionary;
}
 
namespace Antares::Optimisation::LinearProblemMpsolverImpl
{
class OrtoolsLinearProblem;
class OrtoolsMipSolution;
} // namespace Antares::Optimisation::LinearProblemMpsolverImpl
 
namespace Antares::Optimisation
{
class OptimEntityContainer;
 
namespace LinearProblemApi
{
class IMipVariable;
class ILinearProblem;
class ILinearProblemData;
class IMipSolution;
class FillContext;
} // namespace LinearProblemApi
} // namespace Antares::Optimisation
 
namespace Antares::ModelerStudy::SystemModel
{
class Component;
}
 
namespace Antares::Solver
{
// TODO this class needs to be revamped
class IWriter
{
public:
    virtual ~IWriter() = default;
    virtual void init(const std::string& simulationId) = 0;
    virtual void writeSimulationTable(
      const Optimisation::LinearProblemApi::ILinearProblem& linearProblem,
      const Optimisation::LinearProblemApi::IMipSolution& solution,
      const Antares::Modeler::Data& modelerData,
      const Optimisation::OptimEntityContainer& variableContainer,
      const Optimisation::LinearProblemApi::FillContext& fillContext) const
      = 0;
    virtual const std::filesystem::path& outputPath() const = 0;
};
} // namespace Antares::Solver