| Report problems to ATLAS LXR Team (with time and IP address indicated) |
|
[ source navigation ] [ diff markup ] [ identifier search ] [ general search ] |
||||
|
||||||
| Links to LXR source navigation pages for stable releases | [ 12.*.* ] [ 13.*.* ] [ 14.*.* ] [ 15.*.* ] | |||||
001 // $Id: IErrorTool.h,v 1.2 2004/10/18 08:17:59 mato Exp $ 002 // ============================================================================ 003 #ifndef GAUDIALG_IERRORTOOL_H 004 #define GAUDIALG_IERRORTOOL_H 1 005 // ============================================================================ 006 // Include files 007 // ============================================================================ 008 // STD & STL 009 // ============================================================================ 010 #include <string> 011 // ============================================================================ 012 // GaudiKernel 013 // ============================================================================ 014 #include "GaudiKernel/IAlgTool.h" 015 #include "GaudiKernel/StatusCode.h" 016 #include "GaudiKernel/IMessageSvc.h" 017 // ============================================================================ 018 class GaudiException ; 019 020 /** @class IErrorTool IErrorTool.h GaudiTools/IErrorTool.h 021 * 022 * 023 * @author Ivan BELYAEV 024 * @date 2004-06-28 025 */ 026 class IErrorTool : virtual public IAlgTool 027 { 028 public: 029 030 /// Return the unique interface ID 031 static const InterfaceID& interfaceID() ; 032 033 public: 034 035 /** Print the error message, return status code 036 * and perform the statistics of error messages 037 * 038 * @code 039 * 040 * IErrorTool* tool = .. ; 041 * if( a < 0 ) { return tool->Error(" 'a' is negative!") ;} 042 * if( b < 0 ) { return tool->Error(" 'b' is illegal!" , StatusCode(25) ); 043 * if( c < 0 ) 044 * { return tool->Error(" 'c' is negative" , StatusCode(35) , 50 ); 045 * 046 * @endcode 047 * 048 * @see MsgStream 049 * @see IMessageSvc 050 * @see StatusCode 051 * @param msg error message 052 * @param st status code 053 * @param mx maximal number of printouts 054 * @return status code 055 */ 056 virtual StatusCode Error 057 ( const std::string& msg , 058 const StatusCode st = StatusCode::FAILURE , 059 const size_t mx = 10 ) const = 0 ; 060 061 /** Print the warning message, return status code 062 * and perform the statistics of warning messages 063 * @see MsgStream 064 * @see IMessageSvc 065 * @see StatusCode 066 * @param msg warning message 067 * @param st statsu code 068 * @param mx maximal number of printouts 069 * @return status code 070 */ 071 virtual StatusCode Warning 072 ( const std::string& msg , 073 const StatusCode st = StatusCode::FAILURE , 074 const size_t mx = 10 ) const = 0 ; 075 076 /** Print the message and return status code 077 * @see MsgStream 078 * @see IMessageSvc 079 * @see StatusCode 080 * @param msg warning message 081 * @param st status code 082 * @param lev print level 083 * @return status code 084 */ 085 virtual StatusCode Print 086 ( const std::string& msg , 087 const StatusCode st = StatusCode::SUCCESS , 088 const MSG::Level lev = MSG::INFO ) const = 0 ; 089 090 /** Assertion - throw exception, if condition is not fulfilled 091 * @see CaloException 092 * @see GaudiException 093 * @exception CaloException for invalid condifition 094 * @param ok condition which should be "true" 095 * @param message message to be associated with the exception 096 * @param sc status code to be returned (artificial) 097 * @return status code 098 */ 099 virtual StatusCode Assert 100 ( const bool ok , 101 const std::string& message = "" , 102 const StatusCode sc = StatusCode::FAILURE ) const = 0 ; 103 104 /** Create and (re)-throw the exception 105 * @see GaudiException 106 * @exception CaudiException always! 107 * @param msg exception message 108 * @param exc (previous) exception of type GaudiException 109 * @param sc status code 110 * @return status code (fictive) 111 */ 112 virtual StatusCode Exception 113 ( const std::string & msg , 114 const GaudiException & exc , 115 const StatusCode sc = StatusCode::FAILURE ) const = 0 ; 116 117 /** Create and (re)-throw the exception 118 * @see GaudiException 119 * @exception GaudiException always! 120 * @param msg exception message 121 * @param exc (previous) exception of type std::exception 122 * @param sc status code 123 * @return status code (fictive) 124 */ 125 virtual StatusCode Exception 126 ( const std::string & msg , 127 const std::exception & exc , 128 const StatusCode sc = StatusCode::FAILURE ) const = 0 ; 129 130 /** Create and throw the exception 131 * @see GaudiException 132 * @exception GaudiException always! 133 * @param msg exception message 134 * @param sc status code 135 * @return status code (fictive) 136 */ 137 virtual StatusCode Exception 138 ( const std::string& msg = "no message" , 139 const StatusCode sc = StatusCode::FAILURE ) const = 0 ; 140 141 protected: 142 143 // protected destructor 144 virtual ~IErrorTool() ; 145 146 }; 147 148 // ============================================================================ 149 #endif // GAUDIALG_IERRORTOOL_H 150 // ============================================================================ 151
| [ source navigation ] | [ diff markup ] | [ identifier search ] | [ general search ] |
| Due to the LXR bug, the updates fail sometimes to remove references to deleted files. The Saturday's full rebuilds fix these problems | |
| This page was automatically generated by the LXR engine. |
|