MsgLogger/include/MsgLogger.h

Go to the documentation of this file.

#ifndef MSGLOGGER_HH
#define MSGLOGGER_HH

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: MsgLogger.h 2700 2011-12-09 21:52:07Z salnikov@SLAC.STANFORD.EDU $
//
// Description:
//      Class MsgLogger.
//
// Environment:
//      This software was developed for the BaBar collaboration.  If you
//      use all or part of it, please give an appropriate acknowledgment.
//
// Author List:
//      Andy Salnikov
//
// Copyright Information:
//      Copyright (C) 2005 SLAC
//
//------------------------------------------------------------------------

//-------------
// C Headers --
//-------------
extern "C" {
}

//---------------
// C++ Headers --
//---------------
#include <iostream>
#include <string>

//----------------------
// Base Class Headers --
//----------------------

//-------------------------------
// Collaborating Class Headers --
//-------------------------------
#include "MsgLogger/MsgLogStream.h"

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------

//              ---------------------
//              -- Class Interface --
//              ---------------------

namespace MsgLogger {

class MsgHandler ;
class MsgLogRecord ;
class MsgLoggerImpl ;

/**
 *  @ingroup MsgLogger
 *
 *  The class for the first-level processing of the messages. The streams
 *  send messages to this class, and this class forwards them to handlers
 *  (if it decides that message is indeed to be logged.) The loggers are
 *  organized into hierarchical structure, every logger has a parent, except
 *  one root logger which does not have any parents. Every message is also sent
 *  by logger to its parent logger, unless propagate flag is clear.
 *
 *  Note that this class is just a kind of smart poiner  class for the
 *  real objects of the class MsgLoggerImpl which do real job.
 *
 *  This software was developed for the BaBar collaboration.  If you
 *  use all or part of it, please give an appropriate acknowledgment.
 *
 *  Copyright (C) 2005 SLAC
 *
 *  @see MsgLoggerImpl
 *
 *  @version $Id: MsgLogger.h 2700 2011-12-09 21:52:07Z salnikov@SLAC.STANFORD.EDU $
 *
 *  @author Andy Salnikov
 */

class MsgLogger {

public:

  // Construct named logger, or root logger for empty name
  MsgLogger( const std::string& name = "" ) ;

  // default copy ctor is OK
  //MsgLogger( const MsgLogger& );

  // Destructor
  ~MsgLogger() {}

  // default assignment is OK
  //MsgLogger& operator= ( const MsgLogger& );

  /// set the logger level, messages with the level below this won't be logged
  void setLevel ( MsgLogLevel level ) ;

  /// define whether or not we need messages propagated to ancestors
  void propagate ( bool flag ) ;

  /// add a handler for the messages, takes ownership of the object
  void addHandler ( MsgHandler* handler ) ;

  /// check if the specified level will log any message
  bool logging ( MsgLogLevel sev ) const ;

  /// get the stream for the specified log level
  bool log ( const MsgLogRecord& record ) const ;

protected:

  // Helper functions

private:

  // Friends

  // Data members
  MsgLoggerImpl* const _impl ;   // Pointer to the real implementation

};
} // namespace MsgLogger

#endif // MSGLOGGER_HH

---