StatusCode::Category Class Reference

The category assigned to a StatusCode. More...

#include <GaudiKernel/StatusCode.h>

Public Member Functions
constexpr	Category () noexcept=default
virtual	~Category ()
virtual const char *	name () const =0
	Name of the category. More...
virtual std::string	message (code_t code) const
	Description for code within this category. More...
virtual bool	isSuccess (code_t code) const
	Is code considered success ? More...
virtual bool	isRecoverable (code_t code) const
	Is code considered recoverable ? More...

Detailed Description

The category assigned to a StatusCode.

Derive from this class to implement your own category. The mapping of StatusCode values to success and recoverable conditions can be defined by overriding the appropriate methods.

Definition at line 65 of file StatusCode.h.

Constructor & Destructor Documentation

constexpr StatusCode::Category::Category ( )

defaultnoexcept

virtual StatusCode::Category::~Category ( )

inlinevirtual

Definition at line 67 of file StatusCode.h.

{}

Member Function Documentation

virtual bool StatusCode::Category::isRecoverable ( code_t  code ) const

inlinevirtual

Is code considered recoverable ?

Definition at line 80 of file StatusCode.h.

{ return code == static_cast<code_t>( ErrorCode::RECOVERABLE ); }

virtual bool StatusCode::Category::isSuccess ( code_t  code ) const

inlinevirtual

Is code considered success ?

Note

isFailure() cannot be overridden as it is defined as !isSuccess()

Definition at line 77 of file StatusCode.h.

{ return code == static_cast<code_t>( ErrorCode::SUCCESS ); }

virtual std::string StatusCode::Category::message ( code_t  code ) const

inlinevirtual

Description for code within this category.

Definition at line 73 of file StatusCode.h.

{ return "UNKNOWN(" + std::to_string( code ) + ")"; }

virtual const char* StatusCode::Category::name ( ) const

pure virtual

Name of the category.

---

The documentation for this class was generated from the following file:

• GaudiKernel/GaudiKernel/StatusCode.h