Antares Xpansion
Investment simulations for Antares studies
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Output::VoidWriter Class Reference

VoidWriter class to describe the execuion session of an antares xpansion optimization. More...

#include <VoidWriter.h>

Inheritance diagram for Output::VoidWriter:
Output::OutputWriter

Public Member Functions

 VoidWriter ()=default
 VoidWriter default constructor.
 
virtual ~VoidWriter ()=default
 destructor of class VoidWriter
 
virtual void write_iterations (const IterationsData &iterations_data)
 saves some entries to be later written
 
virtual void update_solution (const SolutionData &solution_data)
 saves some entries to be later written
 
virtual void write_failure ()
 write an a priori errored json output, overwritten if optimization ends
 
virtual void dump ()
 write the json data into a file
 
virtual void initialize ()
 initialize outputs
 
virtual void end_writing (const IterationsData &iterations_data)
 
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_iteration (const Iteration &iteration_data, const size_t iteration_num) override
 
void updateBeginTime () override
 
void updateEndTime () 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

VoidWriter class to describe the execuion session of an antares xpansion optimization.

Member Function Documentation

◆ dump()

void Output::VoidWriter::dump ( )
virtual

write the json data into a file

Implements Output::OutputWriter.

◆ end_writing()

void Output::VoidWriter::end_writing ( const IterationsData & iterations_data)
virtual

Implements Output::OutputWriter.

◆ initialize()

void Output::VoidWriter::initialize ( )
virtual

initialize outputs

Implements Output::OutputWriter.

◆ solution_status()

std::string Output::VoidWriter::solution_status ( ) const
overridevirtual

Implements Output::OutputWriter.

◆ update_solution()

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

saves some entries to be later written

Parameters
nbWeeks_p: number of the weeks in the study
lb_p: solution lower bound
ub_p: solution upper bound
investCost_p: investment cost
operationalCost_p: operational cost
overallCost_p: total cost, sum of invest and operational
solution_p: point giving the solution and the candidates
optimality_p: indicates if optimality was reached

Implements Output::OutputWriter.

◆ updateBeginTime()

void Output::VoidWriter::updateBeginTime ( )
overridevirtual

Implements Output::OutputWriter.

◆ updateEndTime()

void Output::VoidWriter::updateEndTime ( )
overridevirtual

Implements Output::OutputWriter.

◆ write_duration()

void Output::VoidWriter::write_duration ( const double duration)
overridevirtual

Implements Output::OutputWriter.

◆ write_failure()

void Output::VoidWriter::write_failure ( )
virtual

write an a priori errored json output, overwritten if optimization ends

write a json output with a failure status in solution. If optimization process exits before it ends, this failure will be available as an output.

◆ write_iteration()

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

Implements Output::OutputWriter.

◆ write_iterations()

void Output::VoidWriter::write_iterations ( const IterationsData & iterations_data)
virtual

saves some entries to be later written

Parameters
nbWeeks_p: number of the weeks in the study
bendersTrace_p: trace to be written ie iterations details
bendersData_p: final benders data to get the best iteration
min_abs_gap: minimum absolute gap wanted
min_rel_gap: minimum relative gap wanted
max_iter: maximum number of iterations

◆ write_log_level()

void Output::VoidWriter::write_log_level ( const int log_level)
overridevirtual

Implements Output::OutputWriter.

◆ write_master_name()

void Output::VoidWriter::write_master_name ( const std::string & master_name)
overridevirtual

Implements Output::OutputWriter.

◆ write_nbweeks()

void Output::VoidWriter::write_nbweeks ( const int nb_weeks)
overridevirtual

Implements Output::OutputWriter.

◆ write_solution()

void Output::VoidWriter::write_solution ( const SolutionData & solution)
overridevirtual

Implements Output::OutputWriter.

◆ write_solver_name()

void Output::VoidWriter::write_solver_name ( const std::string & solver_name)
overridevirtual

Implements Output::OutputWriter.

◆ WriteProblem()

void Output::VoidWriter::WriteProblem ( const ProblemData & problem_data)
overridevirtual

Implements Output::OutputWriter.

◆ WriteProblemFormat()

void Output::VoidWriter::WriteProblemFormat ( const std::string format)
overridevirtual

Implements Output::OutputWriter.

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