ILogger Class Reference

abstract class for operational logs More...

#include <ILogger.h>

Inheritance diagram for ILogger:

Public Member Functions
virtual void	display_message (const std::string &str)=0
	pure virtual method to display a std::string message
virtual void	display_message (const std::string &str, LogUtils::LOGLEVEL level, const std::string &context)=0
virtual void	PrintIterationSeparatorBegin ()=0
virtual void	PrintIterationSeparatorEnd ()=0
virtual void	log_at_initialization (const int it_number)=0
virtual void	log_iteration_candidates (const LogData &d)=0
virtual void	log_master_solving_duration (double durationInSeconds)=0
virtual void	LogSubproblemsSolvingWalltime (double durationInSeconds)=0
virtual void	LogSubproblemsSolvingCumulativeCpuTime (double durationInSeconds)=0
virtual void	log_at_iteration_end (const LogData &d)=0
virtual void	log_at_ending (const LogData &d)=0
virtual void	log_total_duration (double durationInSeconds)=0
virtual void	log_stop_criterion_reached (const StoppingCriterion stopping_criterion)=0
virtual void	display_restart_message ()=0
virtual void	restart_elapsed_time (const double elapsed_time)=0
virtual void	number_of_iterations_before_restart (const int num_iterations)=0
virtual void	restart_best_iteration (const int best_iterations)=0
virtual void	restart_best_iterations_infos (const LogData &best_iterations_data)=0
virtual void	LogAtInitialRelaxation ()=0
virtual void	LogAtSwitchToInteger ()=0
virtual void	cumulative_number_of_sub_problem_solved (int number)=0
Public Member Functions inherited from ILoggerXpansion
void	display_message (const std::ostringstream &msg)

Public Attributes
const std::string	CONTEXT = "Benders"

Detailed Description

abstract class for operational logs

Member Function Documentation

display_message() [1/2]

virtual void ILogger::display_message ( const std::string & str )

pure virtual

pure virtual method to display a std::string message

Parameters

str	the message to be displayed

Implements ILoggerXpansion.

Implemented in LoggerNOOPStub, SimpleLoggerMock, xpansion::logger::Master, xpansion::logger::User, and xpansion::logger::UserFile.

display_message() [2/2]

virtual void ILogger::display_message ( const std::string & str, LogUtils::LOGLEVEL level, const std::string & context )

pure virtual

Implements ILoggerXpansion.

PrintIterationSeparatorBegin()

virtual void ILogger::PrintIterationSeparatorBegin ( )

pure virtual

Implements ILoggerXpansion.

PrintIterationSeparatorEnd()

virtual void ILogger::PrintIterationSeparatorEnd ( )

pure virtual

Implements ILoggerXpansion.

---

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

• src/cpp/xpansion_interfaces/include/antares-xpansion/xpansion_interfaces/ILogger.h