casadi::Logger Class Reference

Keeps track of logging output to screen and/or files. More...

#include <casadi_logger.hpp>

Detailed Description

All printout from CasADi routines should go through this files.

Author

Joel Andersson

Date

2015

Extra doc: https://github.com/casadi/casadi/wiki/L_23u

Definition at line 44 of file casadi_logger.hpp.

Classes
class	Stream
class	Streambuf

Static Public Member Functions
static void	WriteFunThreadSafe (const char *s, std::streamsize num, bool error)
static void	FlushThreadSafe (bool error)
static void	writeDefault (const char *s, std::streamsize num, bool error)
	By default, print to std::cout or std::cerr. More...
static void	flushDefault (bool error)
	By default, flush std::cout or std::cerr. More...
static void	writeIgnore (const char *s, std::streamsize num, bool error)
	Ignore output. More...
template<bool Err>
static void	write (const char *s, std::streamsize num)
	Print output message. More...
template<bool Err>
static void	writeCh (char ch)
	Print log message, single character. More...

Static Public Attributes
static void(*	writeFun )(const char *s, std::streamsize num, bool error)
	Print warnings, can be redefined. More...
static void(*	flush )(bool error) =Logger::flushDefault
	Flush buffers. More...

Member Function Documentation

flushDefault()

static void casadi::Logger::flushDefault ( bool  error )

inlinestatic

Definition at line 69 of file casadi_logger.hpp.

                                         {
      if (error) {
        std::cerr << std::flush;
      } else {
        std::cout << std::flush;
      }
    }

FlushThreadSafe()

void casadi::Logger::FlushThreadSafe ( bool  error )

static

Definition at line 49 of file casadi_logger.cpp.

                                         {
#ifdef CASADI_WITH_THREAD
    std::lock_guard<std::mutex> lock(mutex_logger);
#endif //CASADI_WITH_THREAD
    flush(error);
  }

References flush.

write()

template<bool Err>

static void casadi::Logger::write ( const char *  s, std::streamsize  num  )

inlinestatic

Definition at line 82 of file casadi_logger.hpp.

                                                                           {
      // All information
      WriteFunThreadSafe(s, num, Err);
    }

writeCh()

template<bool Err>

static void casadi::Logger::writeCh ( char  ch )

inlinestatic

Definition at line 88 of file casadi_logger.hpp.

                                                    {
      write<Err>(&ch, 1);
    }

writeDefault()

static void casadi::Logger::writeDefault ( const char *  s, std::streamsize  num, bool  error  )

inlinestatic

Definition at line 60 of file casadi_logger.hpp.

                                                                           {
      if (error) {
        std::cerr.write(s, num);
      } else {
        std::cout.write(s, num);
      }
    }

WriteFunThreadSafe()

void casadi::Logger::WriteFunThreadSafe ( const char *  s, std::streamsize  num, bool  error  )

static

Definition at line 42 of file casadi_logger.cpp.

                                                                              {
#ifdef CASADI_WITH_THREAD
    std::lock_guard<std::mutex> lock(mutex_logger);
#endif //CASADI_WITH_THREAD
    writeFun(s, num, error);
  }

References writeFun.

writeIgnore()

static void casadi::Logger::writeIgnore ( const char *  s, std::streamsize  num, bool  error  )

inlinestatic

Definition at line 78 of file casadi_logger.hpp.

                                                                          {
    }

Member Data Documentation

flush

void(* casadi::Logger::flush)(bool error) =Logger::flushDefault

static

Definition at line 54 of file casadi_logger.hpp.

Referenced by FlushThreadSafe().

writeFun

void(* casadi::Logger::writeFun)(const char *s, std::streamsize num, bool error)

static

Initial value:

=
    Logger::writeDefault

Definition at line 51 of file casadi_logger.hpp.

Referenced by WriteFunThreadSafe().

---

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

• casadi_logger.hpp
• casadi_logger.cpp