StatusCode.h File Reference

#include <boost/preprocessor/facilities/overload.hpp>
#include <functional>
#include <ostream>
#include <type_traits>
#include <utility>
#include <GaudiKernel/Kernel.h>

Include dependency graph for StatusCode.h:

Go to the source code of this file.

Classes
struct	is_StatusCode_enum< T >
class	StatusCode
	This class is used for returning status codes from appropriate routines. More...
struct	StatusCode::Category
	The category assigned to a StatusCode. More...

Macros
#define	STATUSCODE_ENUM_DECL(ENUM)
	Declare an enum to be used as StatusCode value.
#define	STATUSCODE_ENUM_IMPL(...)
	Assign a category to the StatusCode enum declared with STATUSCODE_ENUM_DECL( ENUM )
#define	STATUSCODE_ENUM_IMPL_1(ENUM)
#define	STATUSCODE_ENUM_IMPL_2(ENUM, CATEGORY)

Functions
bool	operator== (const StatusCode &lhs, const StatusCode &rhs)

Macro Definition Documentation

STATUSCODE_ENUM_DECL

#define STATUSCODE_ENUM_DECL

(

ENUM

)

Value:

  template <>                                                                                                          \
  struct is_StatusCode_enum<ENUM> : std::true_type {                                                                   \
    static const StatusCode::Category& instance;                                                                       \
  };

Declare an enum to be used as StatusCode value.

Parameters

ENUM	enum class

Definition at line 286 of file StatusCode.h.

#define STATUSCODE_ENUM_DECL( ENUM )                                                                                   \
  template <>                                                                                                          \
  struct is_StatusCode_enum<ENUM> : std::true_type {                                                                   \
    static const StatusCode::Category& instance;                                                                       \
  };

STATUSCODE_ENUM_IMPL

#define STATUSCODE_ENUM_IMPL

(

...

)

Value:

BOOST_PP_OVERLOAD( STATUSCODE_ENUM_IMPL_, __VA_ARGS__ )( __VA_ARGS__ )

Assign a category to the StatusCode enum declared with STATUSCODE_ENUM_DECL( ENUM )

Parameters

ENUM	enum class
CATEGORY	(optional) category, otherwise use default StatusCode category

Definition at line 295 of file StatusCode.h.

STATUSCODE_ENUM_IMPL_1

#define STATUSCODE_ENUM_IMPL_1

(

ENUM

)

Value:

  const StatusCode::Category& is_StatusCode_enum<ENUM>::instance = StatusCode::default_category();

Definition at line 297 of file StatusCode.h.

#define STATUSCODE_ENUM_IMPL_1( ENUM )                                                                                 \
  const StatusCode::Category& is_StatusCode_enum<ENUM>::instance = StatusCode::default_category();

STATUSCODE_ENUM_IMPL_2

#define STATUSCODE_ENUM_IMPL_2	(		ENUM,
			CATEGORY )

Value:

  const StatusCode::Category& is_StatusCode_enum<ENUM>::instance = CATEGORY{};

Definition at line 300 of file StatusCode.h.

#define STATUSCODE_ENUM_IMPL_2( ENUM, CATEGORY )                                                                       \
  const StatusCode::Category& is_StatusCode_enum<ENUM>::instance = CATEGORY{};

Function Documentation

operator==()

bool operator== ( const StatusCode & lhs, const StatusCode & rhs )

inline

Note

For code values 0(FAILURE) and 1(SUCCESS) the category is ignored

e.g. sc==StatusCode::SUCCESS is equivalent to sc.isSuccess() for all categories

Definition at line 325 of file StatusCode.h.

                                                                       {
  return ( lhs.m_code == rhs.m_code ) &&
         ( lhs.m_code == static_cast<StatusCode::code_t>( StatusCode::ErrorCode::SUCCESS ) ||
           lhs.m_code == static_cast<StatusCode::code_t>( StatusCode::ErrorCode::FAILURE ) ||
           ( lhs.m_cat == rhs.m_cat ) );
}