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
[legend]
Collaboration diagram for BESLog:

Collaboration graph
[legend]

List of all members.

Public Types

typedef ios &(* p_ios_manipulator )(ios &)
 Defines a data type p_ios_manipulator "pointer to function that takes ios& and returns ios&".
typedef ostream &(* p_ostream_manipulator )(ostream &)
 Defines a data type p_ostream_manipulator "pointer to function that takes ostream& and returns ostream&".

Public Member Functions

 ~BESLog ()
 Cleans up the logging mechanism.
void suspend ()
 Suspend logging of any information until resumed.
void resume ()
 Resumes logging after being suspended.
void verbose_on ()
 turn on verbose logging
void verbose_off ()
 turns off verbose logging
bool is_verbose ()
 Returns true if verbose logging is requested.
BESLogoperator<< (string &)
 Overloaded inserter that writes the specified string.
BESLogoperator<< (const string &)
 Overloaded inserter that writes the specified const string.
BESLogoperator<< (char *)
 Overloaded inserter that writes the specified char *.
BESLogoperator<< (const char *)
 Overloaded inserter that writes the specified const char *.
BESLogoperator<< (int)
 Overloaded inserter that writes the specified int value.
BESLogoperator<< (char)
 Overloaded inserter that writes the specified char value.
BESLogoperator<< (long)
 Overloaded inserter that writes the specified long value.
BESLogoperator<< (unsigned long)
 Overloaded inserter that writes the specified unsigned long value.
BESLogoperator<< (double)
 Overloaded inserter that writes the specified double value.
BESLogoperator<< (p_ostream_manipulator)
 Overloaded inserter that takes stream manipulation methods.
BESLogoperator<< (p_ios_manipulator)
 Overloaded inserter that takes ios methods.
virtual void dump (ostream &strm) const
 dumps information about this object

Static Public Member Functions

static BESLogTheLog ()

Protected Member Functions

 BESLog ()
 constructor that sets up logging for the application.
void dump_time ()
 Protected method that dumps the date/time to the log file.


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:

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

See also:
BESKeys

Member Typedef Documentation

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

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

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

Defines a data type p_ostream_manipulator "pointer to function that takes ostream& and returns ostream&".


Constructor & Destructor Documentation

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.

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

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

Here is the call graph for this function:

BESLog::~BESLog (  ) 

Cleans up the logging mechanism.

Cleans up the logging mechanism by closing the log file.


Member Function Documentation

void BESLog::dump_time (  )  [protected]

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

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

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

Referenced by operator<<().

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.

Referenced by BESMemoryGlobalArea::BESMemoryGlobalArea().

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.

Referenced by BESMemoryGlobalArea::BESMemoryGlobalArea().

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.

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.

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

Referenced by BESCmdInterface::invoke_aggregation().

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

Overloaded inserter that writes the specified string.

Parameters:
s string to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified const string.

Parameters:
s const string to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified char *.

Parameters:
val char * to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified const char *.

Parameters:
val const char * to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified int value.

Parameters:
val int value to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified char value.

Parameters:
val char value to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified long value.

Parameters:
val long value to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified unsigned long value.

Parameters:
val unsigned long value to write to the log file

References dump_time().

Here is the call graph for this function:

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

Overloaded inserter that writes the specified double value.

Parameters:
val double value to write to the log file

References dump_time().

Here is the call graph for this function:

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

void BESLog::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

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

Parameters:
strm C++ i/o stream to dump the information to

Implements BESObj.

References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

BESLog * BESLog::TheLog (  )  [static]


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

Generated on Thu Sep 11 07:58:42 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.6