MsgLogger/include/MsgLoggerImpl.h

Go to the documentation of this file.

#ifndef MSGLOGGERIMPL_HH
#define MSGLOGGERIMPL_HH

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: MsgLoggerImpl.h 2700 2011-12-09 21:52:07Z salnikov@SLAC.STANFORD.EDU $
//
// Description:
//      Class MsgLoggerImpl.
//
// 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>
#include <vector>

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

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

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

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

namespace MsgLogger {

class MsgHandler ;
class MsgLogRecord ;

/// @addtogroup MsgLogger_detail

/**
 *  @ingroup MsgLogger_detail
 *
 *  Implementation of the message logger. This class is actually an implementation
 *  detail used by the MsgLogger class. It should not be visible to clients in any way.
 *
 *  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 MsgLogger
 *  @see MsgHandler
 *
 *  @version $Id: MsgLoggerImpl.h 2700 2011-12-09 21:52:07Z salnikov@SLAC.STANFORD.EDU $
 *
 *  @author Andy Salnikov
 */

class MsgLoggerImpl {

public:

  // Construct named logger
  MsgLoggerImpl( const std::string& name ) ;

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

  // Destructor
  ~MsgLoggerImpl();

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

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

  /// define whether or not we need messages propagated to ancestors, root logger never propagates
  void propagate ( bool flag ) { if ( ! _name.empty() ) _propagate = flag ; }

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

  /// name of the logger
  const std::string name() const { return _name ; }

  /// 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 ;

  /// send the message to the handles and parents
  void handle ( MsgLogRecord& record ) const ;

protected:

private:

  // Types
  typedef std::vector<MsgHandler*> HandlerList ;

  // Data members
  std::string _name ;
  MsgLogLevel _level ;
  mutable bool _propagate ;
  mutable MsgLoggerImpl* _parent ;
  HandlerList _handlers ;

//------------------
// Static Members --
//------------------

public:

  static MsgLoggerImpl* getLogger( const std::string& name ) ;

};
} // namespace MsgLogger

#endif // MSGLOGGERIMPL_HH

---