Output::JsonWriter Class Reference

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

#include <JsonWriter.h>

Inheritance diagram for Output::JsonWriter:

Public Member Functions
	JsonWriter ()=delete
	JsonWriter default constructor.
	JsonWriter (std::shared_ptr< Clock > p_clock, const std::filesystem::path &json_filename)
	JsonWriter (const std::filesystem::path &json_filename, const Json::Value &json_file_content)
virtual	~JsonWriter ()=default
	destructor of class JsonWriter
void	updateBeginTime () override
	updates the execution begin time
void	updateEndTime () override
	updates the end of execution time
virtual void	update_solution (const SolutionData &solution_data)
	saves some entries to be later written to the json file
virtual void	dump ()
	write the json data into a file
void	initialize ()
	initialize outputs
void	end_writing (const IterationsData &iterations_data)
void	write_iteration (const Iteration &iteration_data, const size_t iteration_num) override
void	write_solver_name (const std::string &solver_name) override
void	write_master_name (const std::string &master_name) override
void	write_log_level (const int log_level) override
void	write_solution (const SolutionData &solution) override
void	write_nbweeks (const int nb_weeks) override
void	write_duration (const double duration) override
std::string	solution_status () const override
void	WriteProblem (const ProblemData &problem_data) override
void	WriteProblemFormat (const std::string format) override
Public Member Functions inherited from Output::OutputWriter
virtual	~OutputWriter ()=default
	destructor of class OutputWriter

Detailed Description

JsonWriter class to describe the execuion session of an antares xpansion optimization in a json file.

Member Function Documentation

dump()

void Output::JsonWriter::dump ( )

virtual

write the json data into a file

Implements Output::OutputWriter.

end_writing()

void Output::JsonWriter::end_writing ( const IterationsData & iterations_data )

virtual

Implements Output::OutputWriter.

initialize()

void Output::JsonWriter::initialize ( )

virtual

initialize outputs

Parameters

options

: set of options used for the optimization

Implements Output::OutputWriter.

solution_status()

std::string Output::JsonWriter::solution_status ( ) const

overridevirtual

Implements Output::OutputWriter.

update_solution()

void Output::JsonWriter::update_solution ( const SolutionData & solution_data )

virtual

saves some entries to be later written to the json file

Parameters

solution_data

containing solution data

Implements Output::OutputWriter.

updateBeginTime()

void Output::JsonWriter::updateBeginTime ( )

overridevirtual

updates the execution begin time

Implements Output::OutputWriter.

updateEndTime()

void Output::JsonWriter::updateEndTime ( )

overridevirtual

updates the end of execution time

Implements Output::OutputWriter.

write_duration()

void Output::JsonWriter::write_duration ( const double duration )

overridevirtual

Implements Output::OutputWriter.

write_iteration()

void Output::JsonWriter::write_iteration ( const Iteration & iteration_data, const size_t iteration_num )

overridevirtual

Implements Output::OutputWriter.

write_log_level()

void Output::JsonWriter::write_log_level ( const int log_level )

overridevirtual

Implements Output::OutputWriter.

write_master_name()

void Output::JsonWriter::write_master_name ( const std::string & master_name )

overridevirtual

Implements Output::OutputWriter.

write_nbweeks()

void Output::JsonWriter::write_nbweeks ( const int nb_weeks )

overridevirtual

Implements Output::OutputWriter.

write_solution()

void Output::JsonWriter::write_solution ( const SolutionData & solution )

overridevirtual

Implements Output::OutputWriter.

write_solver_name()

void Output::JsonWriter::write_solver_name ( const std::string & solver_name )

overridevirtual

Implements Output::OutputWriter.

WriteProblem()

void Output::JsonWriter::WriteProblem ( const ProblemData & problem_data )

overridevirtual

Implements Output::OutputWriter.

WriteProblemFormat()

void Output::JsonWriter::WriteProblemFormat ( const std::string format )

overridevirtual

Implements Output::OutputWriter.

---

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

• src/cpp/benders/output/include/antares-xpansion/benders/output/JsonWriter.h
• src/cpp/benders/output/JsonWriter.cpp