StatusCode Class Reference

This class is used for returning status codes from appropriate routines. More...

#include <GaudiKernel/StatusCode.h>

Collaboration diagram for StatusCode:

Classes
class	ScopedDisableChecking
	Simple RAII class to ignore unchecked StatusCode instances in a scope. More...

Public Types
enum	{ FAILURE = 0, SUCCESS = 1, RECOVERABLE = 2 }

Public Member Functions
	StatusCode ()=default
	Constructor. More...
	StatusCode (unsigned long code, IssueSeverity &&sev)
	StatusCode (IssueSeverity &&is)
	StatusCode (unsigned long code, bool checked=false)
	StatusCode (const StatusCode &rhs)
	StatusCode (StatusCode &&rhs) noexcept
	Move constructor. More...
	~StatusCode ()
	Destructor. More...
bool	isSuccess () const
	Test for a status code of SUCCESS. More...
bool	isFailure () const
	Test for a status code of FAILURE. More...
bool	isRecoverable () const
unsigned long	getCode () const
	Get the status code by value. More...
void	setCode (unsigned long value)
	Set the status code by value. More...
void	setChecked () const
	Ignore the checking code;. More...
void	ignore () const
	operator unsigned long () const
	Cast operator. More...
GAUDI_API const IssueSeverity &	severity () const
	Severity. More...
StatusCode &	operator= (unsigned long value)
	Assignment operator. More...
StatusCode &	operator= (const StatusCode &rhs)
	operator IgnoreError () const

Static Public Member Functions
static GAUDI_API void	enableChecking ()
static GAUDI_API void	disableChecking ()
static GAUDI_API bool	checkingEnabled ()

Protected Attributes
unsigned long	d_code = SUCCESS
	The status code. More...
bool	m_checked = false
	If the Status code has been checked. More...
std::shared_ptr< const IssueSeverity >	m_severity
	Pointer to a IssueSeverity. More...

Static Protected Attributes
static bool	s_checking
	Global flag to control if StatusCode need to be checked. More...

Private Member Functions
void	check ()

Friends
bool	operator< (const StatusCode &a, const StatusCode &b)
	Comparison operator. More...
bool	operator> (const StatusCode &a, const StatusCode &b)
	Comparison operator. More...

Detailed Description

This class is used for returning status codes from appropriate routines.

Author

Iain Last

Pere Mato

Sebastien Ponce

Definition at line 26 of file StatusCode.h.

Member Enumeration Documentation

anonymous enum

Enumerator
FAILURE
SUCCESS
RECOVERABLE

Definition at line 28 of file StatusCode.h.

       {
    FAILURE = 0,
    SUCCESS = 1,
    RECOVERABLE = 2
  };

Constructor & Destructor Documentation

StatusCode::StatusCode ( )

default

Constructor.

StatusCode::StatusCode ( unsigned long  code, IssueSeverity &&  sev  )

inline

Definition at line 37 of file StatusCode.h.

                                                       :
    d_code(code) {
    try { // ensure that we do not throw even if we cannot move the severity
      m_severity = std::make_shared<const IssueSeverity>(std::move(sev));
    }
    catch (...) {}
  }

StatusCode::StatusCode ( IssueSeverity &&  is )

inline

Definition at line 45 of file StatusCode.h.

                                  :
        StatusCode( is.getLevel() == IssueSeverity::RECOVERABLE ?
                        StatusCode::RECOVERABLE :
                        ( is.getLevel() < IssueSeverity::ERROR ?
                            StatusCode::SUCCESS :
                            StatusCode::FAILURE )
                   , std::move(is) )  { }

StatusCode::StatusCode ( unsigned long  code, bool  checked = false  )

inline

Definition at line 53 of file StatusCode.h.

                                                        :
    d_code(code),m_checked(checked)  {}

StatusCode::StatusCode ( const StatusCode &  rhs )

inline

Definition at line 56 of file StatusCode.h.

                                     :
    d_code(rhs.d_code), m_checked(rhs.m_checked),
    m_severity(rhs.m_severity)
    { rhs.m_checked = true; }

StatusCode::StatusCode ( StatusCode &&  rhs )

inlinenoexcept

Move constructor.

Definition at line 62 of file StatusCode.h.

                                         :
    d_code(rhs.d_code), m_checked(rhs.m_checked),
    m_severity( std::move(rhs.m_severity) )
  { rhs.m_checked = true; }

StatusCode::~StatusCode ( )

inline

Destructor.

Definition at line 68 of file StatusCode.h.

  { if (UNLIKELY(s_checking)) check(); }

Member Function Documentation

void StatusCode::check ( )

private

Fix-Me:

: (MCl) use backTrace(std::string&, const int, const int) instead

Definition at line 36 of file StatusCode.cpp.

                       {

  if (!m_checked && !GaudiException::s_proc && !std::uncaught_exception() ) {

    auto msg = Gaudi::svcLocator()->as<IMessageSvc>();
    auto scs = Gaudi::svcLocator()->service<IStatusCodeSvc>("StatusCodeSvc");

    const size_t depth = 21;
    void* addresses[depth];

    std::string lib, fnc;
    void* addr = nullptr;
    if (System::backTrace(addresses, depth)) {

      for(size_t idx: {2, 3}) {
        if (System::getStackLevel(addresses[idx], addr, fnc, lib) &&
            fnc != "StatusCode::~StatusCode()") {

          if (scs) {
            scs->regFnc(fnc, lib);
          } else {
            MsgStream log(msg, "StatusCode");
            log << MSG::WARNING << "Unchecked in " << fnc
                << " (" << lib << ")" << endmsg;
          }
          break;
        }
      }
    }
  }
}

bool StatusCode::checkingEnabled ( )

static

Definition at line 27 of file StatusCode.cpp.

                                 {
  return s_checking;
}

void StatusCode::disableChecking ( )

static

Definition at line 23 of file StatusCode.cpp.

                                 {
  s_checking = false;
}

void StatusCode::enableChecking ( )

static

Definition at line 19 of file StatusCode.cpp.

                                {
  s_checking = true;
}

unsigned long StatusCode::getCode ( ) const

inline

Get the status code by value.

Definition at line 91 of file StatusCode.h.

                               {
    m_checked = true;
    return d_code;
  }

void StatusCode::ignore ( ) const

inline

Definition at line 106 of file StatusCode.h.

{ setChecked(); }

bool StatusCode::isFailure ( ) const

inline

Test for a status code of FAILURE.

N.B. This is a specific type of failure where there aren't any more appropriate status codes. To test for any failure use : if ( !StatusCode.isSuccess() ) ...

Definition at line 84 of file StatusCode.h.

{ return !isSuccess(); }

bool StatusCode::isRecoverable ( ) const

inline

Definition at line 85 of file StatusCode.h.

                             {
    m_checked = true;
    return (d_code == RECOVERABLE);
  }

bool StatusCode::isSuccess ( ) const

inline

Test for a status code of SUCCESS.

N.B. This is the only case where a function has succeeded.

Definition at line 74 of file StatusCode.h.

                         {
    m_checked = true;
    return (d_code == SUCCESS);
  }

StatusCode::operator IgnoreError ( ) const

inline

Definition at line 139 of file StatusCode.h.

                               {
    m_checked = true;
    return IgnoreError();
  }

StatusCode::operator unsigned long ( ) const

inline

Cast operator.

Definition at line 109 of file StatusCode.h.

{ return getCode(); }

StatusCode& StatusCode::operator= ( unsigned long  value )

inline

Assignment operator.

Definition at line 115 of file StatusCode.h.

                                             {
    setCode(value);
    return *this;
  }

StatusCode& StatusCode::operator= ( const StatusCode &  rhs )

inline

Definition at line 119 of file StatusCode.h.

                                              {
    if (this == &rhs) return *this; // Protection against self-assignment
    d_code = rhs.d_code;
    m_checked = rhs.m_checked;
    rhs.m_checked = true;
    m_severity = rhs.m_severity;
    return *this;
  }

void StatusCode::setChecked ( ) const

inline

Ignore the checking code;.

Definition at line 103 of file StatusCode.h.

                         {
    m_checked = true;
  }

void StatusCode::setCode ( unsigned long  value )

inline

Set the status code by value.

Definition at line 97 of file StatusCode.h.

                                     {
    m_checked = false;
    d_code = value;
  }

const IssueSeverity & StatusCode::severity

(

)

const

Severity.

Definition at line 31 of file StatusCode.cpp.

                                                {
  static const IssueSeverity dummy;
  return  m_severity ? *m_severity : dummy;
}

Friends And Related Function Documentation

bool operator< ( const StatusCode &  a, const StatusCode &  b  )

friend

Comparison operator.

Definition at line 129 of file StatusCode.h.

                                                                     {
    return a.d_code < b.d_code;
  }

bool operator> ( const StatusCode &  a, const StatusCode &  b  )

friend

Comparison operator.

Definition at line 134 of file StatusCode.h.

                                                                     {
    return a.d_code > b.d_code;
  }

Member Data Documentation

unsigned long StatusCode::d_code = SUCCESS

protected

The status code.

The status code

Definition at line 176 of file StatusCode.h.

bool StatusCode::m_checked = false

mutableprotected

If the Status code has been checked.

Definition at line 177 of file StatusCode.h.

std::shared_ptr<const IssueSeverity> StatusCode::m_severity

protected

Pointer to a IssueSeverity.

Definition at line 178 of file StatusCode.h.

bool StatusCode::s_checking

staticprotected

Global flag to control if StatusCode need to be checked.

Definition at line 180 of file StatusCode.h.

---

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

• GaudiKernel/GaudiKernel/StatusCode.h
• GaudiKernel/src/Lib/StatusCode.cpp