bes
Updated for version 3.20.6
|
Provides a mechanism for applications to log information to an external file. More...
#include <BESLog.h>
Public Types | |
typedef std::ios &(* | p_ios_manipulator) (std::ios &) |
Defines a data type p_ios_manipulator "pointer to function that takes ios& and returns ios&". More... | |
typedef std::ostream &(* | p_ostream_manipulator) (std::ostream &) |
Defines a data type p_std::ostream_manipulator "pointer to function that takes std::ostream& and returns std::ostream&". More... | |
Public Member Functions | |
virtual void | dump (std::ostream &strm) const |
dumps information about this object More... | |
virtual void | flush_me () |
std::ostream * | get_log_ostream () |
bool | is_verbose () |
Returns true if verbose logging is requested. More... | |
BESLog & | operator<< (char *) |
Overloaded inserter that writes the specified char *. More... | |
BESLog & | operator<< (char) |
Overloaded inserter that writes the specified char value. More... | |
BESLog & | operator<< (const char *) |
Overloaded inserter that writes the specified const char *. More... | |
BESLog & | operator<< (const std::string &) |
Overloaded inserter that writes the specified const string. More... | |
BESLog & | operator<< (double) |
Overloaded inserter that writes the specified double value. More... | |
BESLog & | operator<< (int) |
Overloaded inserter that writes the specified int value. More... | |
BESLog & | operator<< (long) |
Overloaded inserter that writes the specified long value. More... | |
BESLog & | operator<< (p_ios_manipulator) |
Overloaded inserter that takes ios methods. More... | |
BESLog & | operator<< (p_ostream_manipulator) |
Overloaded inserter that takes stream manipulation methods. More... | |
BESLog & | operator<< (std::string &) |
Overloaded inserter that writes the specified string. More... | |
BESLog & | operator<< (unsigned int) |
BESLog & | operator<< (unsigned long) |
Overloaded inserter that writes the specified unsigned long value. More... | |
void | resume () |
Resumes logging after being suspended. More... | |
void | suspend () |
Suspend logging of any information until resumed. More... | |
void | verbose_off () |
turns off verbose logging More... | |
void | verbose_on () |
turn on verbose logging More... | |
~BESLog () | |
Cleans up the logging mechanism. More... | |
Static Public Member Functions | |
static BESLog * | TheLog () |
Static Public Attributes | |
const static std::string | mark = string("|&|") |
Protected Member Functions | |
BESLog () | |
constructor that sets up logging for the application. More... | |
void | dump_time () |
Protected method that dumps the date/time to the log file. More... | |
Provides a mechanism for applications to log information to an external file.
BESLog provides a mechanism for applications to log information to an external file, such as debugging information. This file is defined in the BESKeys mechanism using the key BES.LogName.
Also provides a mechanism to define whether debugging information should be verbose or not using the BESKeys key/value pair BES.LogVerbose.
Logging can also be suspended and resumed using so named methods.
BESLog is used similar to cerr and cout using the overloaded operator <<.
if( BESLog::TheLog()->is_verbose() ) { *(BESLog::TheLog()) << "This is some information to be logged" << endl ; }
Types of data that can be logged include:
BESLog provides a static method for access to a single BESLog object, TheLog.
typedef std::ios&(* BESLog::p_ios_manipulator) (std::ios &) |
typedef std::ostream&(* BESLog::p_ostream_manipulator) (std::ostream &) |
|
protected |
constructor that sets up logging for the application.
Sets up logging for the application by opening up the logging file and determining verbose logging.
The file name is determined using the BESKeys mechanism. The key used is BES.LogName. The application must be able to write to this directory/file.
Verbose logging is determined also using the BESKeys mechanism. The key used is BES.LogVerbose.
By default, log using UTC. BES.LogTimeLocal=yes will switch to using local time. Times are recorded in IOS8601.
BESInternalError | if BESLogName is not set or if there are problems opening or writing to the log file. |
BESLog::~BESLog | ( | ) |
|
virtual |
|
protected |
|
inline |
Returns true if verbose logging is requested.
This method returns true if verbose logging has been requested either by setting the BESKeys key/value pair BES.LogVerbose=value or by turning on verbose logging using the method verbose_on.
If BES.LogVerbose is set to Yes, YES, or yes then verbose logging is turned on. If set to anything else then verbose logging is not turned on.
BESLog & BESLog::operator<< | ( | char * | val | ) |
BESLog & BESLog::operator<< | ( | char | val | ) |
BESLog & BESLog::operator<< | ( | const char * | val | ) |
BESLog & BESLog::operator<< | ( | const std::string & | s | ) |
BESLog & BESLog::operator<< | ( | double | val | ) |
BESLog & BESLog::operator<< | ( | int | val | ) |
BESLog & BESLog::operator<< | ( | long | val | ) |
BESLog & BESLog::operator<< | ( | p_ios_manipulator | val | ) |
Overloaded inserter that takes ios methods.
Overloaded inserter that can take the address oct, dec and hex functions. This inserter is based on p_ios_manipulator, therefore the C++ standard functions oct, dec and hex can be applied to objects of the class BESLog.
BESLog & BESLog::operator<< | ( | p_ostream_manipulator | val | ) |
Overloaded inserter that takes stream manipulation methods.
Overloaded inserter that can take the address of endl, flush and ends functions. This inserter is based on p_ostream_manipulator, therefore the C++ standard functions for I/O endl, flush, and ends can be applied to objects of the class BESLog.
BESLog & BESLog::operator<< | ( | std::string & | s | ) |
BESLog & BESLog::operator<< | ( | unsigned long | val | ) |
|
inline |
|
inline |
|
inline |
|
inline |