IErrorTool.h

Go to the documentation of this file.

// $Id: IErrorTool.h,v 1.2 2004/10/18 08:17:59 mato Exp $
// ============================================================================
#ifndef GAUDIALG_IERRORTOOL_H 
#define GAUDIALG_IERRORTOOL_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <string>
// ============================================================================
// GaudiKernel 
// ============================================================================
#include "GaudiKernel/IAlgTool.h"
#include "GaudiKernel/StatusCode.h"
#include "GaudiKernel/IMessageSvc.h"
// ============================================================================
class GaudiException ;

class IErrorTool : virtual public IAlgTool 
{
public: 

  static const InterfaceID& interfaceID() ;

public:
  
  virtual StatusCode Error     
  ( const std::string& msg , 
    const StatusCode   st  = StatusCode::FAILURE ,
    const size_t       mx  = 10                  ) const = 0 ;
  
  virtual StatusCode Warning   
  ( const std::string& msg , 
    const StatusCode   st  = StatusCode::FAILURE ,
    const size_t       mx  = 10                  ) const = 0 ;
  
  virtual StatusCode Print     
  ( const std::string& msg , 
    const StatusCode   st  = StatusCode::SUCCESS ,
    const MSG::Level   lev = MSG::INFO           ) const = 0 ;
  
  virtual StatusCode Assert 
  ( const bool         ok                            , 
    const std::string& message = ""                  , 
    const StatusCode   sc      = StatusCode::FAILURE ) const = 0 ;
  
  virtual StatusCode Exception 
  ( const std::string    & msg                        ,  
    const GaudiException & exc                        , 
    const StatusCode       sc  = StatusCode::FAILURE  ) const = 0 ;
  
  virtual StatusCode Exception 
  ( const std::string    & msg                        ,  
    const std::exception & exc                        , 
    const StatusCode       sc  = StatusCode::FAILURE  ) const = 0 ;
  
  virtual StatusCode Exception 
  ( const std::string& msg = "no message"        ,  
    const StatusCode   sc  = StatusCode::FAILURE ) const = 0 ;
  
protected:
  
  // protected destructor
  virtual ~IErrorTool() ;

};

// ============================================================================
#endif // GAUDIALG_IERRORTOOL_H
// ============================================================================