Output::OutputWriter Class Reference

OutputWriter class to describe the execuion session of an antares xpansion optimization in a log file. More...

#include <OutputWriter.h>

Inheritance diagram for Output::OutputWriter:

Public Member Functions
virtual	~OutputWriter ()=default
	destructor of class OutputWriter
virtual void	update_solution (const SolutionData &solution_data)=0
	saves some entries to be later written to the json file
virtual void	dump ()=0
	write the log data into a file
virtual void	initialize ()=0
	initialize outputs
virtual void	end_writing (const IterationsData &iterations_data)=0
virtual void	write_solver_name (const std::string &solver_name)=0
virtual void	write_master_name (const std::string &master_name)=0
virtual void	write_log_level (const int log_level)=0
virtual void	write_solution (const SolutionData &solution)=0
virtual void	write_iteration (const Iteration &iteration_data, const size_t iteration_num)=0
virtual void	updateBeginTime ()=0
virtual void	updateEndTime ()=0
virtual void	write_nbweeks (const int nb_weeks)=0
virtual void	write_duration (const double duration)=0
virtual std::string	solution_status () const =0
virtual void	WriteProblem (const ProblemData &problem_data)=0

Detailed Description

OutputWriter class to describe the execuion session of an antares xpansion optimization in a log file.

Member Function Documentation

dump()

virtual void Output::OutputWriter::dump ( )

pure virtual

write the log data into a file

Implemented in Output::JsonWriter, Output::VoidWriter, and WriterNOOPStub.

initialize()

virtual void Output::OutputWriter::initialize ( )

pure virtual

initialize outputs

Implemented in Output::JsonWriter, Output::VoidWriter, and WriterNOOPStub.

update_solution()

virtual void Output::OutputWriter::update_solution ( const SolutionData &  solution_data )

pure virtual

saves some entries to be later written to the json file

Parameters

solution_data

containing solution data

Implemented in WriterNOOPStub, Output::JsonWriter, and Output::VoidWriter.

updateBeginTime()

virtual void Output::OutputWriter::updateBeginTime ( )

pure virtual

Implemented in Output::JsonWriter.

updateEndTime()

virtual void Output::OutputWriter::updateEndTime ( )

pure virtual

Implemented in Output::JsonWriter.

---

The documentation for this class was generated from the following file:

• src/cpp/xpansion_interfaces/OutputWriter.h