---

/home/pauldt/projects/IDEA/IDEA-ALL/IDEA-DEV/Core/Utilities/Includes/Trace.hh

Go to the documentation of this file.

// -*- Mode: c++ -*-
//     File: $Source: /home/cvs/ISG-Repository/IDEA-DEV/Core/Utilities/Includes/Trace.hh,v $
//      Tag: $Name: DR_01_11_06 $
//      CVS: $Id: Trace.hh,v 1.13 2005/12/30 22:06:06 rijsman Exp $
//     Info: $CVSROOT/Idea3/Copyright.txt
#ifndef _H_IDEA_TRACE
#define _H_IDEA_TRACE

#include "Singleton.hh"
#include <sstream>
#include "TimeBasics.hh"
#include "ThreadTools.hh"

#define TRACE_LOCKING_ON 
   
namespace IDEA 
{
  class Trace:
    public Singleton<Trace>
  {
    friend class Singleton<Trace>;
  public:
    enum OutputLevel
      {
        LOW = 0, /*< Low output, low output mode only traces low output */
        MEDIUM, /*< Medium output, medium output traces low and medium output */
        HIGH, /*< High output, medium output traces low, medium and high output */
        DEBUG /*< Debug output, medium output traces low, medium, high and debug output */
      };

    ~Trace() {}
    void setStream( std::ostream* stream ) { ACE_Guard< RecursiveThreadMutex > guard( m_Mutex ); m_Stream = stream; };
    std::ostream& getStream() { return *m_Stream; }
    RecursiveThreadMutex& getMutex() { return m_Mutex; }
    bool isOutputLevelLow() const { return LOW == m_OutputLevel; }
    bool isOutputLevelMedium() const { return MEDIUM == m_OutputLevel; }
    bool isOutputLevelHigh() const { return HIGH == m_OutputLevel; }
    bool isOutputLevelDebug() const { return DEBUG == m_OutputLevel; }
    void setOutputLevel( OutputLevel level ) { m_OutputLevel = level; }
  private:
    Trace():
      m_Stream( &std::cout ),
      m_OutputLevel( LOW ) 
    {
    }

    std::ostream* m_Stream;
    OutputLevel m_OutputLevel;
    RecursiveThreadMutex m_Mutex;
  };

  std::ostream& operator<<( std::ostream& os, const Trace::OutputLevel& level );
  
  extern Time getElapsedTime();
  extern Time getCurrentTime();
  extern Time getCurrentTick();
  extern const std::string& getAgentName();
} // namespace IDEA

#ifdef TRACE_LOCKING_ON  

#define LOCK_OUTPUT   \
  IDEA::Guard< IDEA::RecursiveThreadMutex > guard( IDEA::Trace::instance()->getMutex(), "TraceLock"); 
#else
 #define LOCK_OUTPUT {}
#endif 

// There are four levels of tracing:
//
// - low, use LOW_TRACE(..) and LOW_TRACE_ON to explicitly turn on in the code
// - medium, use MEDIUM_TRACE(...) and MEDIUM_TRACE_ON to explicitly turn on in the code
// - high, use HIGH_TRACE(...) and HIGH_TRACE_ON to explicitly turn on in the code
// - debug, use DEBUG_TRACE(...) and DEBUG_TRACE_ON to explicitly turn on in the code
//
// Then there is also the possibility to trace without a prefix (time-stamp) by invoking 
//
// \li LOW_TRACE_NO_TIME_STAMP(..), for low output
// \li MEDIUM_TRACE_NO_TIME_STAMP(..), for medium output
// \li HIGH_TRACE_NO_TIME_STAMP(..), for high output
// \li DEBUG_TRACE_NO_TIME_STAMP(..), for debug output
//
// If output is low only low output will be traced
// If output is medium, low and medium output will be traced
// If output is high, low, medium and high output will be traced
// If output is debug, low, medium, high and debug output will be traced

#ifdef TRACE_ON

#define IDEA_TRACE( msg ) \
 { \
   LOCK_OUTPUT; \
   IDEA::Trace::instance()->getStream() << "[ " << IDEA::getAgentName().c_str() << " " \
                 << IDEA::ThreadNames::instance()->getName() << " " \
                 << IDEA::getElapsedTime() << " " \
                 << IDEA::getCurrentTime() << " " \
                 << IDEA::getCurrentTick() << " ] " \
                 << msg << std::endl; \
  } 

#define IDEA_TRACE_NO_TIME_STAMP( msg ) \
 { \
   LOCK_OUTPUT; \
   IDEA::Trace::instance()->getStream() << msg << std::endl; \
 } 

 #define DEBUG_TRACE_ON IDEA::Trace::instance()->setOutputLevel( IDEA::Trace::DEBUG );

 #define HIGH_TRACE_ON IDEA::Trace::instance()->setOutputLevel( IDEA::Trace::HIGH );

 #define MEDIUM_TRACE_ON IDEA::Trace::instance()->setOutputLevel( IDEA::Trace::MEDIUM );

 #define LOW_TRACE_ON IDEA::Trace::instance()->setOutputLevel( IDEA::Trace::LOW );

 #define DEBUG_TRACE( msg ) if( IDEA::Trace::instance()->isOutputLevelDebug() ) IDEA_TRACE( msg ); 

 #define HIGH_TRACE( msg ) if( IDEA::Trace::instance()->isOutputLevelHigh() || IDEA::Trace::instance()->isOutputLevelDebug() ) IDEA_TRACE( msg ); 

 #define MEDIUM_TRACE( msg ) if( !IDEA::Trace::instance()->isOutputLevelLow() ) IDEA_TRACE( msg ); 

 #define LOW_TRACE( msg ) IDEA_TRACE( msg )

 #define DEBUG_TRACE_NO_TIME_STAMP( msg ) if( IDEA::Trace::instance()->isOutputLevelDebug() ) IDEA_TRACE_NO_TIME_STAMP( msg ); 

 #define HIGH_TRACE_NO_TIME_STAMP( msg ) if( IDEA::Trace::instance()->isOutputLevelHigh() || IDEA::Trace::instance()->isOutputLevelDebug() ) IDEA_TRACE_NO_TIME_STAMP( msg ); 

 #define MEDIUM_TRACE_NO_TIME_STAMP( msg ) if( !IDEA::Trace::instance()->isOutputLevelLow() ) IDEA_TRACE_NO_TIME_STAMP( msg ); 

 #define LOW_TRACE_NO_TIME_STAMP( msg ) IDEA_TRACE_NO_TIME_STAMP( msg )

 #define DET_TRACE( msg ) MEDIUM_TRACE( msg )

 #define DET_TRACE_NO_TIME_STAMP( msg ) MEDIUM_TRACE_NO_TIME_STAMP( msg )

 #define trace( msg ) LOW_TRACE( msg )

 #define trace_no_time_stamp( msg ) LOW_TRACE_NO_TIME_STAMP( msg )

#else  
 #define IDEA_TRACE( msg ) 
 #define IDEA_TRACE_NO_TIME_STAMP( msg ) 

 #define DEBUG_TRACE_ON 
 #define HIGH_TRACE_ON 
 #define MEDIUM_TRACE_ON 
 #define LOW_TRACE_ON 

 #define DEBUG_TRACE( msg )
 #define HIGH_TRACE( msg ) {}
 #define LOW_TRACE( msg ) {}
 #define MEDIUM_TRACE( msg ) {}

 #define DEBUG_TRACE_NO_TIME_STAMP( msg ) {}
 #define HIGH_TRACE_NO_TIME_STAMP( msg ) {}
 #define MEDIUM_TRACE_NO_TIME_STAMP( msg ) {}
 #define LOW_TRACE_NO_TIME_STAMP( msg ) {}

 #define DET_TRACE( msg ) {}
 #define DET_TRACE_NO_TIME_STAMP( msg ) {}
 #define trace( msg ) {}
 #define trace_no_time_stamp( msg ) {}

#endif // TRACE_ON

#endif //_H_IDEA_TRACE

---

Contact information © IDEA