ATLAS Offline Software
Macros
AthCheckMacros.h File Reference
#include "AthenaKernel/errorcheck.h"
Include dependency graph for AthCheckMacros.h:

Go to the source code of this file.

Macros

#define ATH_REPORT_ERROR_WITH_CONTEXT   REPORT_ERROR_WITH_CONTEXT
 Report an error, with an explicitly specified context name. More...
 
#define ATH_REPORT_MESSAGE_WITH_CONTEXT   REPORT_MESSAGE_WITH_CONTEXT
 Report a message, with an explicitly specified context name. More...
 
#define ATH_REPORT_ERROR   REPORT_ERROR
 Report an error. More...
 
#define ATH_REPORT_MESSAGE   REPORT_MESSAGE
 Report a message. More...
 
#define ATH_CHECK_WITH_CONTEXT   CHECK_WITH_CONTEXT
 Evaluate an expression and check for errors, with an explicitly specified context name. More...
 
#define ATH_CHECK   CHECK
 
#define ATH_CHECK_RECOVERABLE_WITH_CONTEXT   CHECK_RECOVERABLE_WITH_CONTEXT
 Evaluate an expression and check for errors, with an explicitly specified context name. More...
 
#define ATH_CHECK_RECOVERABLE   CHECK_RECOVERABLE
 Evaluate an expression and check for errors. More...
 
#define ATH_CHECK_FATAL_WITH_CONTEXT   CHECK_FATAL_WITH_CONTEXT
 Evaluate an expression and check for errors, with an explicitly specified context name. More...
 
#define ATH_CHECK_FATAL   CHECK_FATAL
 Evaluate an expression and check for errors. More...
 

Macro Definition Documentation

◆ ATH_CHECK

#define ATH_CHECK   CHECK

Definition at line 41 of file AthCheckMacros.h.

◆ ATH_CHECK_FATAL

#define ATH_CHECK_FATAL   CHECK_FATAL

Evaluate an expression and check for errors.

this must be available to get the context name.

Parameters
EXPThe expression to evaluate.

This macro will evaluate EXP, which should return a StatusCode. If the status is not successful, then an error message will be produced, and FAILURE will be returned to the caller.

Definition at line 57 of file AthCheckMacros.h.

◆ ATH_CHECK_FATAL_WITH_CONTEXT

#define ATH_CHECK_FATAL_WITH_CONTEXT   CHECK_FATAL_WITH_CONTEXT

Evaluate an expression and check for errors, with an explicitly specified context name.

Parameters
EXPThe expression to evaluate.
CONTEXT_NAMEThe name of the current context.

This macro will evaluate EXP, which should return a StatusCode. If the status is not successful, then an error message will be produced, and FAILURE will be returned to the caller.

Definition at line 53 of file AthCheckMacros.h.

◆ ATH_CHECK_RECOVERABLE

#define ATH_CHECK_RECOVERABLE   CHECK_RECOVERABLE

Evaluate an expression and check for errors.

this must be available to get the context name.

Parameters
EXPThe expression to evaluate.

This macro will evaluate EXP, which should return a StatusCode. If the status is not successful, then an error message will be produced, and RECOVERABLE will be returned to the caller.

Definition at line 49 of file AthCheckMacros.h.

◆ ATH_CHECK_RECOVERABLE_WITH_CONTEXT

#define ATH_CHECK_RECOVERABLE_WITH_CONTEXT   CHECK_RECOVERABLE_WITH_CONTEXT

Evaluate an expression and check for errors, with an explicitly specified context name.

Parameters
EXPThe expression to evaluate.
CONTEXT_NAMEThe name of the current context.

This macro will evaluate EXP, which should return a StatusCode. If the status is not successful, then an error message will be produced, and RECOVERABLE will be returned to the caller.

Definition at line 45 of file AthCheckMacros.h.

◆ ATH_CHECK_WITH_CONTEXT

#define ATH_CHECK_WITH_CONTEXT   CHECK_WITH_CONTEXT

Evaluate an expression and check for errors, with an explicitly specified context name.

Parameters
EXPThe expression to evaluate.
CONTEXT_NAMEThe name of the current context.
RET(optional) return value different from EXP

This macro will evaluate EXP, which should return a StatusCode. If the status is not successful, then an error message will be produced, and the failing StatusCode (or RET) will be returned to the caller.

Definition at line 37 of file AthCheckMacros.h.

◆ ATH_REPORT_ERROR

#define ATH_REPORT_ERROR   REPORT_ERROR

Report an error.

this must be available to get the context name.

Parameters
SCThe StatusCode.

Additional text may be appended with the output stream operator.

Definition at line 29 of file AthCheckMacros.h.

◆ ATH_REPORT_ERROR_WITH_CONTEXT

#define ATH_REPORT_ERROR_WITH_CONTEXT   REPORT_ERROR_WITH_CONTEXT

Report an error, with an explicitly specified context name.

Parameters
SCThe StatusCode.
CONTEXT_NAMEThe name of the current context.

Additional text may be appended with the output stream operator.

Definition at line 21 of file AthCheckMacros.h.

◆ ATH_REPORT_MESSAGE

#define ATH_REPORT_MESSAGE   REPORT_MESSAGE

Report a message.

this must be available to get the context name.

Parameters
LVLThe error logging level.

Additional text may be appended with the output stream operator.

Definition at line 33 of file AthCheckMacros.h.

◆ ATH_REPORT_MESSAGE_WITH_CONTEXT

#define ATH_REPORT_MESSAGE_WITH_CONTEXT   REPORT_MESSAGE_WITH_CONTEXT

Report a message, with an explicitly specified context name.

Parameters
LVLThe error logging level.
CONTEXT_NAMEThe name of the current context.

Additional text may be appended with the output stream operator.

Definition at line 25 of file AthCheckMacros.h.