Logging::FMTTaskLogger Class Reference

Logger derived from FMTLogger that does not print solver information nor default logging, for use in tasks. More...

#include <FMTTaskLogger.h>

Inheritance diagram for Logging::FMTTaskLogger:

Collaboration diagram for Logging::FMTTaskLogger:

Public Member Functions
	FMTTaskLogger ()
	Default constructor for FMTTaskLogger.
	FMTTaskLogger (const FMTTaskLogger &)=default
	Default copy constructor for FMTTaskLogger.
FMTTaskLogger &	operator= (const FMTTaskLogger &)=default
	Default copy assignment operator for FMTTaskLogger.
	~FMTTaskLogger ()=default
	Default destructor for FMTTaskLogger.
int	print () override
	Print nothing with the OSI solver interface. See FMTLogger::print.
void	checkSeverity () override
	It will do nothing because coinMessagehandler does not support multithread access.
FMTLogger *	clone () const override
	Clone the logger for the OSI solver interface. See FMTLogger::clone.
virtual std::unique_ptr< FMTLogger >	Clone () const
	clone the FMTTaskLogger
Public Member Functions inherited from Logging::FMTLogger
	FMTLogger ()
	Default constructor for FMTLogger.
virtual	~FMTLogger ()
	Default destructor for FMTLogger.
	FMTLogger (const FMTLogger &rhs)
	Copy constructor for FMTLogger.
void	redirectToFile (const std::string &filename, bool logStamp=true)
	Redirect the log information to a file.
void	closeFileStream ()
	Close the file stream.
FMTLogger &	operator= (const FMTLogger &rhs)
	Copy assignment operator for FMTLogger.
virtual int	print ()
	Print function overloaded from CoinMessageHandler when using the OSI solver interface.
virtual void	checkSeverity ()
	Check the severity of the message to be printed by the CoinMessageHandler base class.
virtual FMTLogger *	clone () const =0
	Clone the logger, needed for the abstract CoinMessageHandler usage.
virtual std::string	getLogStamp () const
	Return the basic log stamp as a string.
virtual void	logStamp ()
	Log information about the version of FMT and its build date.
virtual void	logTime ()
	Log the actual time at which the function is called.
void	setStreamFlush (bool flush)
	Force the flushing of the file stream.
virtual FMTLogger &	operator<< (const std::string &msg)
	Append a string to the log.
virtual FMTLogger &	operator<< (const int &msg)
	Append an int to the log.
virtual FMTLogger &	operator<< (const double &msg)
	Append a double to the log.
virtual FMTLogger &	operator<< (const float &msg)
	Append a float to the log.
virtual FMTLogger &	operator<< (const std::time_t &msg)
	Append a std::time_t to the log.
virtual FMTLogger &	operator<< (const size_t &msg)
	Append a size_t to the log.
virtual FMTLogger &	operator<< (const unsigned int &msg)
	Append an unsigned int to the log.
virtual FMTLogger &	operator<< (const void *&msg)
	Append the address of a void pointer to the log.
virtual bool	logWithLevel (const std::string &p_msg, const int &p_messageLevel) const
	Log a message with a given message level if message level is greater of equal to the logger level then it will be printed.
virtual FMTSolverLogger *	getSolverLogger ()
	Return the abstract logger used by the OSI solver interface.
virtual std::unique_ptr< FMTLogger >	Clone () const =0
	clone the FMTLogger

Friends
class	boost::serialization::access
	Serialize the FMTTaskLogger through its base FMTLogger for multiprocessing across multiple cpus (pickle in Python).

Additional Inherited Members
Protected Member Functions inherited from Logging::FMTLogger
virtual void	_cout (const char *message) const
	Output a message, sometimes needed on Windows with boost::python to print directly into the Python window.
virtual void	_setLoggingLevel (const int &level)
	Set the solver logger logging level.
Protected Attributes inherited from Logging::FMTLogger
std::unique_ptr< FMTSolverLogger >	m_solverref
std::string	m_filepath
	string path the the potential filestream
std::unique_ptr< std::ofstream >	m_FileStream
	stream if the logger redirect the logging into somesort of file.
boost::recursive_mutex	m_mtx
	Mutex for multi-threading.
bool	m_flushstream
	If true will flush stream at each write.

Detailed Description

Logger derived from FMTLogger that does not print solver information nor default logging, for use in tasks.

Constructor & Destructor Documentation

FMTTaskLogger() [1/2]

Logging::FMTTaskLogger::FMTTaskLogger

(

)

Default constructor for FMTTaskLogger.

FMTTaskLogger() [2/2]

Logging::FMTTaskLogger::FMTTaskLogger ( const FMTTaskLogger &  )

default

Default copy constructor for FMTTaskLogger.

~FMTTaskLogger()

Logging::FMTTaskLogger::~FMTTaskLogger ( )

default

Default destructor for FMTTaskLogger.

Member Function Documentation

checkSeverity()

void Logging::FMTTaskLogger::checkSeverity ( )

overridevirtual

It will do nothing because coinMessagehandler does not support multithread access.

Reimplemented from Logging::FMTLogger.

Clone()

virtual std::unique_ptr< FMTLogger > Logging::FMTTaskLogger::Clone ( ) const

virtual

clone the FMTTaskLogger

Returns

a valid cloned FMTTaskLogger

Implements Logging::FMTLogger.

clone()

FMTLogger * Logging::FMTTaskLogger::clone ( ) const

overridevirtual

Clone the logger for the OSI solver interface. See FMTLogger::clone.

Returns

a pointer to the cloned logger.

Implements Logging::FMTLogger.

operator=()

FMTTaskLogger & Logging::FMTTaskLogger::operator= ( const FMTTaskLogger &  )

default

Default copy assignment operator for FMTTaskLogger.

Returns

a reference to this FMTTaskLogger.

print()

int Logging::FMTTaskLogger::print ( )

overridevirtual

Print nothing with the OSI solver interface. See FMTLogger::print.

Returns

the value returned by the print function.

Reimplemented from Logging::FMTLogger.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Serialize the FMTTaskLogger through its base FMTLogger for multiprocessing across multiple cpus (pickle in Python).

Template Parameters

Archive

the archive type.

Parameters

[in,out]	ar	the archive to serialize to or from.
[in]	version	the serialization version.

---

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

• D:/FMT/Include/FMTTaskLogger.h