bes  Updated for version 3.20.6
BESLog Class Reference

Provides a mechanism for applications to log information to an external file. More...

#include <BESLog.h>

Collaboration diagram for BESLog:
Collaboration graph

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...
 
BESLogoperator<< (char *)
 Overloaded inserter that writes the specified char *. More...
 
BESLogoperator<< (char)
 Overloaded inserter that writes the specified char value. More...
 
BESLogoperator<< (const char *)
 Overloaded inserter that writes the specified const char *. More...
 
BESLogoperator<< (const std::string &)
 Overloaded inserter that writes the specified const string. More...
 
BESLogoperator<< (double)
 Overloaded inserter that writes the specified double value. More...
 
BESLogoperator<< (int)
 Overloaded inserter that writes the specified int value. More...
 
BESLogoperator<< (long)
 Overloaded inserter that writes the specified long value. More...
 
BESLogoperator<< (p_ios_manipulator)
 Overloaded inserter that takes ios methods. More...
 
BESLogoperator<< (p_ostream_manipulator)
 Overloaded inserter that takes stream manipulation methods. More...
 
BESLogoperator<< (std::string &)
 Overloaded inserter that writes the specified string. More...
 
BESLogoperator<< (unsigned int)
 
BESLogoperator<< (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 BESLogTheLog ()
 

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...
 

Detailed Description

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:

  • std::string
  • char *
  • const char *
  • int
  • char
  • long
  • unsigned long
  • double
  • stream manipulators endl, ends and flush
  • ios manipulators hex, oct, dec

BESLog provides a static method for access to a single BESLog object, TheLog.

See also
TheBESKeys

Definition at line 103 of file BESLog.h.

Member Typedef Documentation

◆ p_ios_manipulator

typedef std::ios&(* BESLog::p_ios_manipulator) (std::ios &)

Defines a data type p_ios_manipulator "pointer to function that takes ios& and returns ios&".

Definition at line 191 of file BESLog.h.

◆ p_ostream_manipulator

typedef std::ostream&(* BESLog::p_ostream_manipulator) (std::ostream &)

Defines a data type p_std::ostream_manipulator "pointer to function that takes std::ostream& and returns std::ostream&".

Definition at line 193 of file BESLog.h.

Constructor & Destructor Documentation

◆ BESLog()

BESLog::BESLog ( )
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.

Exceptions
BESInternalErrorif BESLogName is not set or if there are problems opening or writing to the log file.
See also
BESKeys

Definition at line 72 of file BESLog.cc.

◆ ~BESLog()

BESLog::~BESLog ( )

Cleans up the logging mechanism.

Cleans up the logging mechanism by closing the log file.

Definition at line 131 of file BESLog.cc.

Member Function Documentation

◆ dump()

void BESLog::dump ( std::ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance along with information about the log file

Parameters
strmC++ i/o stream to dump the information to

Implements BESObj.

Definition at line 360 of file BESLog.cc.

◆ dump_time()

void BESLog::dump_time ( )
protected

Protected method that dumps the date/time to the log file.

Depending on the compile-time constant ISO8601_TIME_IN_LOGS, the time is dumped to the log file in the format: "MDT Thu Sep 9 11:05:16 2004", or in ISO8601 format: "YYYY-MM-DDTHH:MM:SS zone"

Definition at line 145 of file BESLog.cc.

◆ is_verbose()

bool BESLog::is_verbose ( )
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.

Returns
true if verbose logging has been requested.
See also
verbose_on
verbose_off
BESKeys

Definition at line 185 of file BESLog.h.

◆ operator<<() [1/11]

BESLog & BESLog::operator<< ( char *  val)

Overloaded inserter that writes the specified char *.

Parameters
valchar * to write to the log file

Definition at line 215 of file BESLog.cc.

◆ operator<<() [2/11]

BESLog & BESLog::operator<< ( char  val)

Overloaded inserter that writes the specified char value.

Parameters
valchar value to write to the log file

Definition at line 272 of file BESLog.cc.

◆ operator<<() [3/11]

BESLog & BESLog::operator<< ( const char *  val)

Overloaded inserter that writes the specified const char *.

Parameters
valconst char * to write to the log file

Definition at line 231 of file BESLog.cc.

◆ operator<<() [4/11]

BESLog & BESLog::operator<< ( const std::string &  s)

Overloaded inserter that writes the specified const string.

Parameters
sconst string to write to the log file

Definition at line 202 of file BESLog.cc.

◆ operator<<() [5/11]

BESLog & BESLog::operator<< ( double  val)

Overloaded inserter that writes the specified double value.

Parameters
valdouble value to write to the log file

Definition at line 311 of file BESLog.cc.

◆ operator<<() [6/11]

BESLog & BESLog::operator<< ( int  val)

Overloaded inserter that writes the specified int value.

Parameters
valint value to write to the log file

Definition at line 249 of file BESLog.cc.

◆ operator<<() [7/11]

BESLog & BESLog::operator<< ( long  val)

Overloaded inserter that writes the specified long value.

Parameters
vallong value to write to the log file

Definition at line 285 of file BESLog.cc.

◆ operator<<() [8/11]

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.

Definition at line 347 of file BESLog.cc.

◆ operator<<() [9/11]

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.

Definition at line 327 of file BESLog.cc.

◆ operator<<() [10/11]

BESLog & BESLog::operator<< ( std::string &  s)

Overloaded inserter that writes the specified string.

Todo:
Decide if this is really necessary.
Parameters
sstring to write to the log file

Definition at line 189 of file BESLog.cc.

◆ operator<<() [11/11]

BESLog & BESLog::operator<< ( unsigned long  val)

Overloaded inserter that writes the specified unsigned long value.

Parameters
valunsigned long value to write to the log file

Definition at line 298 of file BESLog.cc.

◆ resume()

void BESLog::resume ( )
inline

Resumes logging after being suspended.

This method resumes logging after suspended by the user. If logging was not already suspended this method does nothing.

Definition at line 144 of file BESLog.h.

◆ suspend()

void BESLog::suspend ( )
inline

Suspend logging of any information until resumed.

This method suspends any logging of information. If already suspended then nothing changes, logging is still suspended.

Definition at line 134 of file BESLog.h.

◆ verbose_off()

void BESLog::verbose_off ( )
inline

turns off verbose logging

This methods turns off verbose logging. If verbose logging was not already turned on then nothing changes.

Definition at line 165 of file BESLog.h.

◆ verbose_on()

void BESLog::verbose_on ( )
inline

turn on verbose logging

This method turns on verbose logging, providing applications the ability to log more detailed debugging information. If verbose is already turned on then nothing is changed.

Definition at line 155 of file BESLog.h.


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