---

Logger.h

Go to the documentation of this file.

/*
Copyright (c) 2000-2003, Jelle Kok, University of Amsterdam
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the University of Amsterdam nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef _LOGGER_
#define _LOGGER_

#include <iostream>   // needed for ostream (logging to output stream)
#include <fstream>    // needed for fstream (logging to file)
#include <string>     // needed for string
#include <iomanip>    // needed for setw
#include <set>        // needed for set

#ifdef WIN32
  #include <windows.h>  // needed for DWORD and GetTickCount() function
  #include <time.h>     // needed for time_t
#else
  #include <sys/time.h> // needed for timeval
#endif

using namespace std;

#define MAX_LOG_LINE 3072 
#define MAX_HEADER   128  
/*****************************************************************************/
/*********************** CLASS TIMING ****************************************/
/*****************************************************************************/

class Timing
{
#ifdef WIN32
  DWORD  time1;                  
#else
  struct timeval time1;          
#endif
  
public:
  // methods to restart the timer, get the elapsed time and print messages
#ifdef WIN32
  static double getTimeDifference    ( DWORD tv1, DWORD tv2                  );
#else
  static double getTimeDifference    ( struct   timeval t1,
                                       struct   timeval t2                   );
#endif
  void          printTimeDiffWithText( ostream& os,
                                       char     *str,
                                       int      iFactor = 1000               );
  double        getElapsedTime       ( int      iFactor = 1                  );
  void          restartTime          (                                       );
} ;


/*****************************************************************************/
/**************************** LOGGER *****************************************/
/*****************************************************************************/

class Logger
{
  Timing   m_timing;               
  char     m_buf[MAX_LOG_LINE];    
  set<int> m_setLogLevels;         
  pthread_mutex_t mutex_stream; 
  char     m_strHeader[MAX_HEADER];
  ostream* m_os;                   
  string   m_strSignal;            
public:
  Logger( ostream& os=cout, int iMinLogLevel=0, int iMaxLogLevel = 0);

  // different methods associated with logging messages
  bool     log              ( int         iLevel, string str              );
  bool     log              ( int         i,      char   *str, ...        );
  bool     logWithTime      ( int         iLevel, char   *str, ...        );
  bool     logFromSignal    ( int         iLevel, char   *str, ...        );
  bool     logSignal        (                                             );
  
  void     restartTimer     (                                             );
  Timing   getTiming        (                                             );
  bool     isInLogLevel     ( int         iLevel                          );

  bool     addLogLevel      ( int         iLevel                          );
  bool     addLogRange      ( int         iMin,   int iMax                );

  char*    getHeader        (                                             );
  bool     setHeader        ( char        *str                            );
  bool     setHeader        ( int         i                               );
  bool     setHeader        ( int         i1,     int    i2               );

  bool     setOutputStream  ( ostream&    os                              );
  ostream& getOutputStream  (                                             );
  void     showLogLevels    ( ostream&    os                              );
};


#endif

---