---

CdbDebugStream.hh

Go to the documentation of this file.

#ifndef CDB_DEBUG_STREAM_HH
#define CDB_DEBUG_STREAM_HH

// File and Version Information:
//      $Id: CdbDebugStream.hh,v 1.4 2004/10/08 04:55:01 salnikov Exp $

#include "CdbBase/CdbTimeUtils.hh"

#include <iostream>
#include <fstream>

/// The "debug" streamer utility
/**
  * This utility class provides an interface to a controllable "debug" stream to where
  * a test output of client code can be printed through.
  *
  * This facility provides essentially the same kind of service as "COUT1" when
  * the following environment variable is set up as follows:
  *
  *     setenv BDBDEBUG1 std::cout
  *
  * Note, that in the current implementation of the class there is _no_ check
  * on the actual value of the above mentioned variable. A prsense of teh variable
  * would turn the stream on.
  */
class CdbDebugStream {

private:

  /// Default constructor
  /**
    * Can only be used by the static fuctory method.
    *
    * @see CdbDebugStream::instance()
    */
    CdbDebugStream( );

  /// The copy constructor (NOT IMPLEMENTED)

    CdbDebugStream( const CdbDebugStream& );

  /// Destructor
  /**
    * Can only be used by the static fuctory method.
    *
    * @see CdbDebugStream::instance()
    */
    ~CdbDebugStream( );

  /// The asignment operator (NOT IMPLEMENTED)

    CdbDebugStream& operator=( const CdbDebugStream& );

public:

  /// Get the instance of the streamer

    static CdbDebugStream& instance( );

public:

  /// Get the stream
  /**
    * This is the actual stream to be used for the output.
    */
    std::ostream& stream( ) { return *_myStream ; }

private:

    std::ostream* _myStream ;
    bool _destroy ;
};

/// A shortcut definition for the stream 
/**
  * The current timestamp would be printed at the beginning of the line.
  *
  * @see CdbTimeUtils::get_current_timestamp( )
  */
#define CDB_DEBUG_STREAM CdbDebugStream::instance( ).stream( ) << CdbTimeUtils::get_current_timestamp( ) << " "

#endif  // CDB_DEBUG_STREAM_HH

---