All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
StatusCode Class Reference

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

#include <GaudiKernel/StatusCode.h>

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 ()
 Constructor. More...
 
 StatusCode (unsigned long code, const IssueSeverity &sev)
 
 StatusCode (unsigned long code, bool checked=false)
 
 StatusCode (const StatusCode &rhs)
 
 StatusCode (StatusCode &&rhs)
 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 IssueSeverityseverity () const
 Severity. More...
 
StatusCodeoperator= (unsigned long value)
 Assignment operator. More...
 
StatusCodeoperator= (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 Types

typedef boost::shared_ptr
< IssueSeverity
SeverityPtr
 

Protected Attributes

unsigned long d_code
 The status code. More...
 
bool m_checked
 If the Status code has been checked. More...
 
SeverityPtr 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 30 of file StatusCode.h.

Member Typedef Documentation

typedef boost::shared_ptr<IssueSeverity> StatusCode::SeverityPtr
protected

Definition at line 186 of file StatusCode.h.

Member Enumeration Documentation

anonymous enum
Enumerator
FAILURE 
SUCCESS 
RECOVERABLE 

Definition at line 32 of file StatusCode.h.

Constructor & Destructor Documentation

StatusCode::StatusCode ( )
inline

Constructor.

Definition at line 39 of file StatusCode.h.

39  :
40  d_code(SUCCESS), m_checked(false), m_severity() {}
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
SeverityPtr m_severity
Pointer to a IssueSeverity.
Definition: StatusCode.h:188
unsigned long d_code
The status code.
Definition: StatusCode.h:177
StatusCode::StatusCode ( unsigned long  code,
const IssueSeverity sev 
)
inline

Definition at line 41 of file StatusCode.h.

41  :
42  d_code(code),m_checked(false), m_severity() {
43  try { // ensure that we do not throw even if we cannot copy the severity
44 #if (defined(__GXX_EXPERIMENTAL_CXX0X__) || __cplusplus >= 201103L) && ! defined(__GCCXML__)
45  m_severity = std::make_shared<IssueSeverity>(sev);
46 #else
48 #endif
49  }
50  catch (...) {}
51  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
SeverityPtr m_severity
Pointer to a IssueSeverity.
Definition: StatusCode.h:188
unsigned long d_code
The status code.
Definition: StatusCode.h:177
boost::shared_ptr< IssueSeverity > SeverityPtr
Definition: StatusCode.h:186
StatusCode::StatusCode ( unsigned long  code,
bool  checked = false 
)
inline

Definition at line 52 of file StatusCode.h.

52  :
53  d_code(code),m_checked(checked), m_severity() {}
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
SeverityPtr m_severity
Pointer to a IssueSeverity.
Definition: StatusCode.h:188
unsigned long d_code
The status code.
Definition: StatusCode.h:177
StatusCode::StatusCode ( const StatusCode rhs)
inline

Definition at line 55 of file StatusCode.h.

55  :
56  d_code(rhs.d_code), m_checked(rhs.m_checked),
58  { rhs.m_checked = true; }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
SeverityPtr m_severity
Pointer to a IssueSeverity.
Definition: StatusCode.h:188
unsigned long d_code
The status code.
Definition: StatusCode.h:177
StatusCode::StatusCode ( StatusCode &&  rhs)
inline

Move constructor.

Definition at line 62 of file StatusCode.h.

62  :
63  d_code(rhs.d_code), m_checked(rhs.m_checked),
64  m_severity( std::move(rhs.m_severity) )
65  { rhs.m_checked = true; }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
SeverityPtr m_severity
Pointer to a IssueSeverity.
Definition: StatusCode.h:188
unsigned long d_code
The status code.
Definition: StatusCode.h:177
StatusCode::~StatusCode ( )
inline

Destructor.

Definition at line 69 of file StatusCode.h.

70  { if (UNLIKELY(s_checking)) check(); }
#define UNLIKELY(x)
Definition: Kernel.h:127
void check()
Definition: StatusCode.cpp:37
static bool s_checking
Global flag to control if StatusCode need to be checked.
Definition: StatusCode.h:190

Member Function Documentation

void StatusCode::check ( )
private
Fix-Me:
: (MCl) use backTrace(std::string&, const int, const int) instead

Definition at line 37 of file StatusCode.cpp.

37  {
38 
39  if (!m_checked && !GaudiException::s_proc && !std::uncaught_exception() ) {
40 
42 
43  SmartIF<IStatusCodeSvc> scs(Gaudi::svcLocator()->service("StatusCodeSvc"));
44 
45  const size_t depth = 21;
46  void* addresses[depth];
47 
48  std::string lib, fnc;
49  void* addr = 0;
51  if (System::backTrace(addresses, depth)) {
52 
53  for(size_t idx: {2, 3})
54  if (System::getStackLevel(addresses[idx], addr, fnc, lib) &&
55  fnc != "StatusCode::~StatusCode()") {
56 
57  if (scs) {
58  scs->regFnc(fnc, lib);
59  } else {
60  MsgStream log(msg, "StatusCode");
61  log << MSG::WARNING << "Unchecked in " << fnc
62  << " (" << lib << ")" << endmsg;
63  }
64  break;
65  }
66 
67  }
68  }
69 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
GAUDI_API bool getStackLevel(void *addresses, void *&addr, std::string &fnc, std::string &lib)
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
static bool s_proc
"previous" element in the linked list
GAUDI_API int backTrace(void **addresses, const int depth)
GAUDI_API ISvcLocator * svcLocator()
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
bool StatusCode::checkingEnabled ( )
static

Definition at line 27 of file StatusCode.cpp.

27  {
28  return s_checking;
29 }
static bool s_checking
Global flag to control if StatusCode need to be checked.
Definition: StatusCode.h:190
void StatusCode::disableChecking ( )
static

Definition at line 23 of file StatusCode.cpp.

23  {
24  s_checking = false;
25 }
static bool s_checking
Global flag to control if StatusCode need to be checked.
Definition: StatusCode.h:190
void StatusCode::enableChecking ( )
static

Definition at line 19 of file StatusCode.cpp.

19  {
20  s_checking = true;
21 }
static bool s_checking
Global flag to control if StatusCode need to be checked.
Definition: StatusCode.h:190
unsigned long StatusCode::getCode ( ) const
inline

Get the status code by value.

Definition at line 92 of file StatusCode.h.

92  {
93  m_checked = true;
94  return d_code;
95  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
unsigned long d_code
The status code.
Definition: StatusCode.h:177
void StatusCode::ignore ( ) const
inline

Definition at line 107 of file StatusCode.h.

107 { setChecked(); }
void setChecked() const
Ignore the checking code;.
Definition: StatusCode.h:104
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 85 of file StatusCode.h.

85 { return !isSuccess(); }
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
bool StatusCode::isRecoverable ( ) const
inline

Definition at line 86 of file StatusCode.h.

86  {
87  m_checked = true;
88  return (d_code == RECOVERABLE);
89  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
unsigned long d_code
The status code.
Definition: StatusCode.h:177
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 75 of file StatusCode.h.

75  {
76  m_checked = true;
77  return (d_code == SUCCESS);
78  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
unsigned long d_code
The status code.
Definition: StatusCode.h:177
StatusCode::operator IgnoreError ( ) const
inline

Definition at line 140 of file StatusCode.h.

140  {
141  m_checked = true;
142  return IgnoreError();
143  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
StatusCode::operator unsigned long ( ) const
inline

Cast operator.

Definition at line 110 of file StatusCode.h.

110 { return getCode(); }
unsigned long getCode() const
Get the status code by value.
Definition: StatusCode.h:92
StatusCode& StatusCode::operator= ( unsigned long  value)
inline

Assignment operator.

Definition at line 116 of file StatusCode.h.

116  {
117  setCode(value);
118  return *this;
119  }
void setCode(unsigned long value)
Set the status code by value.
Definition: StatusCode.h:98
StatusCode& StatusCode::operator= ( const StatusCode rhs)
inline

Definition at line 120 of file StatusCode.h.

120  {
121  if (this == &rhs) return *this; // Protection against self-assignment
122  d_code = rhs.d_code;
123  m_checked = rhs.m_checked;
124  rhs.m_checked = true;
125  m_severity = rhs.m_severity;
126  return *this;
127  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
SeverityPtr m_severity
Pointer to a IssueSeverity.
Definition: StatusCode.h:188
unsigned long d_code
The status code.
Definition: StatusCode.h:177
void StatusCode::setChecked ( ) const
inline

Ignore the checking code;.

Definition at line 104 of file StatusCode.h.

104  {
105  m_checked = true;
106  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
void StatusCode::setCode ( unsigned long  value)
inline

Set the status code by value.

Definition at line 98 of file StatusCode.h.

98  {
99  m_checked = false;
100  d_code = value;
101  }
bool m_checked
If the Status code has been checked.
Definition: StatusCode.h:178
unsigned long d_code
The status code.
Definition: StatusCode.h:177
const IssueSeverity & StatusCode::severity ( ) const

Severity.

Definition at line 31 of file StatusCode.cpp.

31  {
32  static IssueSeverity dummy;
33  if (m_severity) return *m_severity;
34  else return dummy;
35 }
SeverityPtr m_severity
Pointer to a IssueSeverity.
Definition: StatusCode.h:188

Friends And Related Function Documentation

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

Comparison operator.

Definition at line 130 of file StatusCode.h.

130  {
131  return a.d_code < b.d_code;
132  }
unsigned long d_code
The status code.
Definition: StatusCode.h:177
bool operator> ( const StatusCode a,
const StatusCode b 
)
friend

Comparison operator.

Definition at line 135 of file StatusCode.h.

135  {
136  return a.d_code > b.d_code;
137  }
unsigned long d_code
The status code.
Definition: StatusCode.h:177

Member Data Documentation

unsigned long StatusCode::d_code
protected

The status code.

The status code

Definition at line 177 of file StatusCode.h.

bool StatusCode::m_checked
mutableprotected

If the Status code has been checked.

Definition at line 178 of file StatusCode.h.

SeverityPtr StatusCode::m_severity
protected

Pointer to a IssueSeverity.

Definition at line 188 of file StatusCode.h.

bool StatusCode::s_checking
staticprotected

Global flag to control if StatusCode need to be checked.

Definition at line 190 of file StatusCode.h.


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