IErrorTool.h

Go to the documentation of this file.

#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 GAUDI_API IErrorTool: virtual public IAlgTool
{
public:
  DeclareInterfaceID(IErrorTool,2,0);

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 void Assert
  ( const bool         ok                            ,
    const std::string& message = ""                  ,
    const StatusCode   sc      = StatusCode::FAILURE ) const = 0 ;

  virtual void Exception
  ( const std::string    & msg                        ,
    const GaudiException & exc                        ,
    const StatusCode       sc  = StatusCode::FAILURE  ) const = 0 ;

  virtual void Exception
  ( const std::string    & msg                        ,
    const std::exception & exc                        ,
    const StatusCode       sc  = StatusCode::FAILURE  ) const = 0 ;

  virtual void Exception
  ( const std::string& msg = "no message"        ,
    const StatusCode   sc  = StatusCode::FAILURE ) const = 0 ;

protected:

  // protected destructor
  virtual ~IErrorTool()  = default;

};

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