| The Gaudi Framework v28r2-patches (bc4ad17a)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

IErrorTool.h
Go to the documentation of this file.
1 #ifndef GAUDIALG_IERRORTOOL_H
2 #define GAUDIALG_IERRORTOOL_H 1
3 // ============================================================================
4 // Include files
5 // ============================================================================
6 // STD & STL
7 // ============================================================================
8 #include <string>
9 // ============================================================================
10 // GaudiKernel
11 // ============================================================================
12 #include "GaudiKernel/IAlgTool.h"
13 #include "GaudiKernel/StatusCode.h"
14 #include "GaudiKernel/IMessageSvc.h"
15 // ============================================================================
16 class GaudiException ;
17
24 class GAUDI_API IErrorTool: virtual public IAlgTool
25 {
26 public:
28 DeclareInterfaceID(IErrorTool,2,0);
29
30 public:
31
53 virtual StatusCode Error
54 ( const std::string& msg ,
55 const StatusCode st = StatusCode::FAILURE ,
56 const size_t mx = 10 ) const = 0 ;
57
68 virtual StatusCode Warning
69 ( const std::string& msg ,
70 const StatusCode st = StatusCode::FAILURE ,
71 const size_t mx = 10 ) const = 0 ;
72
82 virtual StatusCode Print
83 ( const std::string& msg ,
84 const StatusCode st = StatusCode::SUCCESS ,
85 const MSG::Level lev = MSG::INFO ) const = 0 ;
86
96 virtual void Assert
97 ( const bool ok ,
98 const std::string& message = "" ,
99 const StatusCode sc = StatusCode::FAILURE ) const = 0 ;
100
109 virtual void Exception
110 ( const std::string & msg ,
111 const GaudiException & exc ,
112 const StatusCode sc = StatusCode::FAILURE ) const = 0 ;
113
122 virtual void Exception
123 ( const std::string & msg ,
124 const std::exception & exc ,
125 const StatusCode sc = StatusCode::FAILURE ) const = 0 ;
126
134 virtual void Exception
135 ( const std::string& msg = "no message" ,
136 const StatusCode sc = StatusCode::FAILURE ) const = 0 ;
137
138 protected:
139
140 // protected destructor
141 virtual ~IErrorTool() = default;
142
143 };
144
145 // ============================================================================
146 #endif // GAUDIALG_IERRORTOOL_H
147 // ============================================================================
StatusCode::SUCCESS
Definition: StatusCode.h:30
GaudiException
Define general base for Gaudi exception.
Definition: GaudiException.h:23
StatusCode::FAILURE
Definition: StatusCode.h:29
IAlgTool::DeclareInterfaceID
DeclareInterfaceID(IAlgTool, 4, 0)
InterfaceID.
std::string
STL class.
MSG::Level
Level
Definition: IMessageSvc.h:15
IErrorTool
Definition: IErrorTool.h:24
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
IAlgTool.h
IMessageSvc.h
std::exception
STL class.
IAlgTool
The interface implemented by the AlgTool base class.
Definition: IAlgTool.h:23
GaudiMP.FdsRegistry.msg
msg
Definition: FdsRegistry.py:8
StatusCode.h
MSG::INFO
Definition: IMessageSvc.h:19
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:107