bes  Updated for version 3.17.0
BESLog Class Reference

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

#include <BESLog.h>

Inheritance diagram for BESLog:
Inheritance 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&".
 
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&".
 

Public Member Functions

virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
std::ostream * get_log_ostream ()
 
bool is_verbose ()
 Returns true if verbose logging is requested. More...
 
BESLogoperator<< (std::string &)
 Overloaded inserter that writes the specified string. More...
 
BESLogoperator<< (const std::string &)
 Overloaded inserter that writes the specified const string. More...
 
BESLogoperator<< (char *)
 Overloaded inserter that writes the specified char *. More...
 
BESLogoperator<< (const char *)
 Overloaded inserter that writes the specified const char *. More...
 
BESLogoperator<< (int)
 Overloaded inserter that writes the specified int value. More...
 
BESLogoperator<< (char)
 Overloaded inserter that writes the specified char value. More...
 
BESLogoperator<< (long)
 Overloaded inserter that writes the specified long value. More...
 
BESLogoperator<< (unsigned long)
 Overloaded inserter that writes the specified unsigned long value. More...
 
BESLogoperator<< (double)
 Overloaded inserter that writes the specified double value. More...
 
BESLogoperator<< (p_ostream_manipulator)
 Overloaded inserter that takes stream manipulation methods. More...
 
BESLogoperator<< (p_ios_manipulator)
 Overloaded inserter that takes ios methods. 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 ()
 

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

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
BESKeys

Definition at line 87 of file BESLog.h.

Constructor & Destructor Documentation

BESLog::BESLog ( )
protected

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.

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

Definition at line 66 of file BESLog.cc.

References BESKeys::get_value(), and TheBESKeys::TheKeys().

BESLog::~BESLog ( )

Cleans up the logging mechanism by closing the log file.

Definition at line 104 of file BESLog.cc.

Member Function Documentation

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

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 294 of file BESLog.cc.

References BESLog().

void BESLog::dump_time ( )
protected

The time is dumped to the log file in the format:

[MDT Thu Sep 9 11:05:16 2004 id: <pid>]

Definition at line 117 of file BESLog.cc.

bool BESLog::is_verbose ( )
inline

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 161 of file BESLog.h.

BESLog & BESLog::operator<< ( std::string &  s)
Todo:
Decide if this is really necessary.
Parameters
sstring to write to the log file

Definition at line 138 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( const std::string &  s)
Parameters
sconst string to write to the log file

Definition at line 151 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( char *  val)
Parameters
valchar * to write to the log file

Definition at line 164 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( const char *  val)
Parameters
valconst char * to write to the log file

Definition at line 180 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( int  val)
Parameters
valint value to write to the log file

Definition at line 198 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( char  val)
Parameters
valchar value to write to the log file

Definition at line 211 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( long  val)
Parameters
vallong value to write to the log file

Definition at line 224 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( unsigned long  val)
Parameters
valunsigned long value to write to the log file

Definition at line 237 of file BESLog.cc.

References dump_time().

BESLog & BESLog::operator<< ( double  val)
Parameters
valdouble value to write to the log file

Definition at line 250 of file BESLog.cc.

References dump_time().

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

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 266 of file BESLog.cc.

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

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 281 of file BESLog.cc.

void BESLog::resume ( )
inline

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

Definition at line 120 of file BESLog.h.

void BESLog::suspend ( )
inline

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

Definition at line 110 of file BESLog.h.

void BESLog::verbose_off ( )
inline

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

Definition at line 141 of file BESLog.h.

void BESLog::verbose_on ( )
inline

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 131 of file BESLog.h.


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