gz/common/Console.hh File Reference

#include <iostream>
#include <fstream>
#include <memory>
#include <mutex>
#include <sstream>
#include <string>
#include <gz/common/Export.hh>
#include <gz/utils/SuppressWarning.hh>
#include <gz/common/Util.hh>

Go to the source code of this file.

Classes
class	Logger::Buffer
	String buffer for the base logger. More...
class	FileLogger::Buffer
	String buffer for the file logger. More...
class	Console
	Container for loggers, and global logging options (such as verbose vs. quiet output). More...
class	FileLogger
	A logger that outputs messages to a file. More...
class	Logger
	Terminal logger. More...

Namespaces
	gz
	Forward declarations for the common classes.
	gz::common

Macros
#define	gzdbg   (Console::dbg(__FILE__, __LINE__))
	Output a debug message, if the verbose level is >= 4. More...
#define	gzerr   (Console::err(__FILE__, __LINE__))
	Output an error message, if the verbose level is >= 1. More...
#define	gzlog   (Console::log())
	Output a message to a log file, regardless of verbosity level. More...
#define	gzLogClose()   Console::log.Close()
	Close the file used for logging. More...
#define	gzLogDirectory()   (Console::log.LogDirectory())
	Get the full path of the directory where the log files are stored. More...
#define	gzLogInit(_dir, _file)   Console::log.Init(_dir, _file)
	Initialize log file with filename given by _dir/_file. If called twice, it will close the file currently in use and open a new log file. More...
#define	gzmsg   (Console::msg())
	Output a message, if the verbose level is >= 3. More...
#define	gzwarn   (Console::warn(__FILE__, __LINE__))
	Output a warning message, if the verbose level is >= 2. More...
#define	igndbg   gzdbg
#define	ignerr   gzerr
#define	ignlog   gzlog
#define	ignLogClose()   gzLogClose()
#define	ignLogDirectory()   gzLogDirectory()
#define	ignLogInit(_dir, _file)   gzLogInit(_dir, _file)
#define	ignmsg   gzmsg
#define	ignwarn   gzwarn

Macro Definition Documentation

gzdbg

#define gzdbg   (Console::dbg(__FILE__, __LINE__))

Output a debug message, if the verbose level is >= 4.

gzerr

#define gzerr   (Console::err(__FILE__, __LINE__))

Output an error message, if the verbose level is >= 1.

gzlog

#define gzlog   (Console::log())

Output a message to a log file, regardless of verbosity level.

gzLogClose

#define gzLogClose

(

)

Console::log.Close()

Close the file used for logging.

gzLogDirectory

#define gzLogDirectory

(

)

(Console::log.LogDirectory())

Get the full path of the directory where the log files are stored.

Returns

Full path of the directory

gzLogInit

#define gzLogInit	(		_dir,
			_file
	)		Console::log.Init(_dir, _file)

Initialize log file with filename given by _dir/_file. If called twice, it will close the file currently in use and open a new log file.

Parameters

[in]	_dir	Name of directory in which to store the log file. Note that if _dir is not an absolute path, then _dir will be relative to your home directory.
[in]	_file	Name of log file for ignlog messages.

gzmsg

#define gzmsg   (Console::msg())

Output a message, if the verbose level is >= 3.

gzwarn

#define gzwarn   (Console::warn(__FILE__, __LINE__))

Output a warning message, if the verbose level is >= 2.

igndbg

#define igndbg   gzdbg

ignerr

#define ignerr   gzerr

ignlog

#define ignlog   gzlog

ignLogClose

#define ignLogClose

(

)

gzLogClose()

ignLogDirectory

#define ignLogDirectory

(

)

gzLogDirectory()

ignLogInit

#define ignLogInit	(		_dir,
			_file
	)		gzLogInit(_dir, _file)

ignmsg

#define ignmsg   gzmsg

ignwarn

#define ignwarn   gzwarn