| The Gaudi Framework v30r0 (c919700c)

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

- File List
- File Members

ErrorTool.h
Go to the documentation of this file.
1 #ifndef GAUDIALG_ERRORTOOL_H
2 #define GAUDIALG_ERRORTOOL_H 1
3 // ============================================================================
4 // Include files
5 // ============================================================================
6 // Gaudi
7 // ============================================================================
8 #include "GaudiAlg/GaudiTool.h"
9 #include "GaudiAlg/IErrorTool.h"
10 // ============================================================================
11
12 // ============================================================================
19 // ============================================================================
20
21 class ErrorTool : public GaudiTool, virtual public IErrorTool
22 {
23
24 public:
32 ErrorTool( const std::string& type, const std::string& name, const IInterface* parent );
33
35 ~ErrorTool() override = default;
36
37 public:
59 StatusCode Error( const std::string& msg, const StatusCode st = StatusCode::FAILURE,
60 const size_t mx = 10 ) const override
61 {
62 return GaudiTool::Error( msg, st, mx );
63 }
64
75 StatusCode Warning( const std::string& msg, const StatusCode st = StatusCode::FAILURE,
76 const size_t mx = 10 ) const override
77 {
78 return GaudiTool::Warning( msg, st, mx );
79 }
80
90 StatusCode Print( const std::string& msg, const StatusCode st = StatusCode::SUCCESS,
91 const MSG::Level lev = MSG::INFO ) const override
92 {
93 return GaudiTool::Print( msg, st, lev );
94 }
95
105 void Assert( const bool ok, const std::string& message = "",
106 const StatusCode sc = StatusCode::FAILURE ) const override
107 {
108 GaudiTool::Assert( ok, message, sc );
109 }
110
119 void Exception( const std::string& msg, const GaudiException& exc,
120 const StatusCode sc = StatusCode::FAILURE ) const override
121 {
122 GaudiTool::Exception( msg, exc, sc );
123 }
124
133 void Exception( const std::string& msg, const std::exception& exc,
134 const StatusCode sc = StatusCode::FAILURE ) const override
135 {
136 GaudiTool::Exception( msg, exc, sc );
137 }
138
146 void Exception( const std::string& msg = "no message", const StatusCode sc = StatusCode::FAILURE ) const override
147 {
148 GaudiTool::Exception( msg, sc );
149 }
150 };
151
152 #endif // GAUDIALG_ERRORTOOL_H
StatusCode::SUCCESS
Definition: StatusCode.h:29
IErrorTool.h
CommonMessagingBase::msg
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:121
GaudiTool::Warning
StatusCode Warning(const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
Print the warning message and return with the given StatusCode.
Definition: GaudiTool.h:699
GaudiTool.h
Header file for class GaudiAlgorithm.
GaudiException
Define general base for Gaudi exception.
Definition: GaudiException.h:22
ErrorTool::Exception
void Exception(const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode::FAILURE) const override
Create and (re)-throw the exception.
Definition: ErrorTool.h:119
IAlgTool::type
virtual const std::string & type() const =0
The type of an AlgTool, meaning the concrete AlgTool class.
ErrorTool::Assert
void Assert(const bool ok, const std::string &message="", const StatusCode sc=StatusCode::FAILURE) const override
Assertion - throw exception, if condition is not fulfilled.
Definition: ErrorTool.h:105
std::string
STL class.
MSG::Level
Level
Definition: IMessageSvc.h:16
ErrorTool::Print
StatusCode Print(const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const override
Print the message and return status code.
Definition: ErrorTool.h:90
IErrorTool
Definition: IErrorTool.h:24
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
IInterface
Definition of the basic interface.
Definition: IInterface.h:277
ErrorTool
Definition: ErrorTool.h:21
GaudiCommon< AlgTool >::Print
WARN_UNUSED StatusCode Print(const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
Print the message and return with the given StatusCode.
ErrorTool::Warning
StatusCode Warning(const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const override
Print the warning message, return status code and perform the statistics of warning messages...
Definition: ErrorTool.h:75
std::exception
STL class.
ErrorTool::ErrorTool
ErrorTool(const std::string &type, const std::string &name, const IInterface *parent)
Standard constructor.
Definition: ErrorTool.cpp:32
AlgTool::name
const std::string & name() const override
Retrieve full identifying name of the concrete tool object.
Definition: AlgTool.cpp:63
GaudiTool::Error
StatusCode Error(const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
Print the error message and return with the given StatusCode.
Definition: GaudiTool.h:671
ErrorTool::Error
StatusCode Error(const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const override
Print the error message, return status code and perform the statistics of error messages.
Definition: ErrorTool.h:59
GaudiCommon< AlgTool >::Assert
void Assert(const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
Assertion - throw exception if the given condition is not fulfilled.
GaudiTool
The useful base class for tools.
Definition: GaudiTool.h:101
ErrorTool::Exception
void Exception(const std::string &msg="no message", const StatusCode sc=StatusCode::FAILURE) const override
Create and throw the exception.
Definition: ErrorTool.h:146
StatusCode::FAILURE
Definition: StatusCode.h:29
ErrorTool::Exception
void Exception(const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode::FAILURE) const override
Create and (re)-throw the exception.
Definition: ErrorTool.h:133
MSG::INFO
Definition: IMessageSvc.h:16
ErrorTool::~ErrorTool
~ErrorTool() override=default
virtual and protected destructor
IAlgTool::parent
virtual const IInterface * parent() const =0
The parent of the concrete AlgTool.
GaudiCommon< AlgTool >::Exception
void Exception(const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
Create and (re)-throw a given GaudiException.