Gaudi Framework, version v22r0
Home   Generated: 9 Feb 2011

StatusCode Class Reference

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

#include <GaudiKernel/StatusCode.h>

List of all members.

Public Types

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

Public Member Functions

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

Static Public Member Functions

static GAUDI_API void enableChecking ()
static GAUDI_API void disableChecking ()

Protected Types

typedef boost::shared_ptr
< IssueSeverity > 		SeverityPtr

Protected Attributes

unsigned long d_code
 The status code.
bool m_checked
 If the Status code has been checked.
SeverityPtr m_severity
 Pointer to a IssueSeverity.

Static Protected Attributes

static bool s_checking
 Global flag to control if StatusCode need to be checked.

Friends

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

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 Typedef Documentation

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

Definition at line 136 of file StatusCode.h.

Member Enumeration Documentation

anonymous enum
Enumerator:
FAILURE 
SUCCESS 
RECOVERABLE 

Definition at line 28 of file StatusCode.h.

00028        {
00029     FAILURE = 0,
00030     SUCCESS = 1,
00031     RECOVERABLE = 2
00032   };

Constructor & Destructor Documentation

StatusCode::StatusCode (  )  [inline]

Constructor.

Definition at line 35 of file StatusCode.h.

00036               :
    d_code(SUCCESS), m_checked(false), m_severity() {}

StatusCode::StatusCode ( unsigned long  code,
const IssueSeverity &  sev 
) [inline]

Definition at line 37 of file StatusCode.h.

00038                                                             :
00039     d_code(code),m_checked(false), m_severity() {
00040     try { // ensure that we do not throw even if the we cannot copy the severity
00041       m_severity = SeverityPtr(new IssueSeverity(sev));
00042     }
00043     catch (...) {}
  }

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

Definition at line 44 of file StatusCode.h.

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

StatusCode::StatusCode ( const StatusCode &  rhs  )  [inline]

Definition at line 47 of file StatusCode.h.

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

StatusCode::~StatusCode (  ) 

Destructor.

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

Definition at line 32 of file StatusCode.cpp.

00032                         {
00033   if(s_checking) {
00034 
00035     if (!m_checked && !GaudiException::s_proc) {
00036 
00037       SmartIF<IMessageSvc> msg(Gaudi::svcLocator());
00038 
00039       SmartIF<IStatusCodeSvc> scs(Gaudi::svcLocator()->service("StatusCodeSvc"));
00040 
00041       const size_t depth = 21;
00042       void* addresses[depth];
00043 
00044       std::string lib, fnc;
00045       void* addr = 0;
00047       if (System::backTrace(addresses, depth)) {
00048 
00049         if (System::getStackLevel(addresses[2], addr, fnc, lib)) {
00050 
00051           if (scs) {
00052             scs->regFnc(fnc,lib);
00053           } else {
00054             if (msg) {
00055               MsgStream log(msg,"StatusCode");
00056               log << MSG::WARNING << "Unchecked in " << fnc << " " << lib << endmsg;
00057             } else {
00058               std::cout << MSG::WARNING << "Unchecked in " << fnc << " " << lib << std::endl;
00059             }
00060           }
00061 
00062         }
00063 
00064       }
00065     }
00066   }
00067 }

Member Function Documentation

void StatusCode::disableChecking (  )  [static]

Definition at line 22 of file StatusCode.cpp.

00022                                  {
00023   s_checking = false;
00024 }

void StatusCode::enableChecking (  )  [static]

Definition at line 18 of file StatusCode.cpp.

00018                                 {
00019   s_checking = true;
00020 }

unsigned long StatusCode::getCode (  )  const [inline]

Get the status code by value.

Definition at line 75 of file StatusCode.h.

00075                                {
00076     m_checked = true;
00077     return d_code;
00078   }

void StatusCode::ignore (  )  const [inline]

Definition at line 90 of file StatusCode.h.

00090 { 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 68 of file StatusCode.h.

00068 { return !isSuccess(); }

bool StatusCode::isRecoverable (  )  const [inline]

Definition at line 69 of file StatusCode.h.

00069                              {
00070     m_checked = true;
00071     return (d_code == RECOVERABLE);
00072   }

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 58 of file StatusCode.h.

00058                          {
00059     m_checked = true;
00060     return (d_code == SUCCESS);
00061   }

StatusCode::operator IgnoreError (  )  const [inline]

Definition at line 123 of file StatusCode.h.

00123                                {
00124     m_checked = true;
00125     return IgnoreError();
00126   }

StatusCode::operator unsigned long (  )  const [inline]

Cast operator.

Definition at line 93 of file StatusCode.h.

00093 { return getCode(); }

StatusCode& StatusCode::operator= ( const StatusCode &  rhs  )  [inline]

Definition at line 103 of file StatusCode.h.

00103                                               {
00104     if (this == &rhs) return *this; // Protection against self-assignment
00105     d_code = rhs.d_code;
00106     m_checked = rhs.m_checked;
00107     rhs.m_checked = true;
00108     m_severity = rhs.m_severity;
00109     return *this;
00110   }

StatusCode& StatusCode::operator= ( unsigned long  value  )  [inline]

Assignment operator.

Definition at line 99 of file StatusCode.h.

00099                                              {
00100     setCode(value);
00101     return *this;
00102   }

void StatusCode::setChecked (  )  const [inline]

Ignore the checking code;.

Definition at line 87 of file StatusCode.h.

00087                          {
00088     m_checked = true;
00089   }

void StatusCode::setCode ( unsigned long  value  )  [inline]

Set the status code by value.

Definition at line 81 of file StatusCode.h.

00081                                      {
00082     m_checked = false;
00083     d_code = value;
00084   }

const IssueSeverity & StatusCode::severity (  )  const

Severity.

Definition at line 26 of file StatusCode.cpp.

00026                                                 {
00027   static IssueSeverity dummy;
00028   if (m_severity) return *m_severity;
00029   else            return dummy;
00030 }

Friends And Related Function Documentation

bool operator< ( const StatusCode &  a,
const StatusCode &  b 
) [friend]

Comparison operator.

Definition at line 113 of file StatusCode.h.

00113                                                                      {
00114     return a.d_code < b.d_code;
00115   }

bool operator> ( const StatusCode &  a,
const StatusCode &  b 
) [friend]

Comparison operator.

Definition at line 118 of file StatusCode.h.

00118                                                                      {
00119     return a.d_code > b.d_code;
00120   }

Member Data Documentation

unsigned long StatusCode::d_code [protected]

The status code.

The status code

Definition at line 134 of file StatusCode.h.

bool StatusCode::m_checked [mutable, protected]

If the Status code has been checked.

Definition at line 135 of file StatusCode.h.

SeverityPtr StatusCode::m_severity [protected]

Pointer to a IssueSeverity.

Definition at line 137 of file StatusCode.h.

bool StatusCode::s_checking [static, protected]

Global flag to control if StatusCode need to be checked.

Definition at line 139 of file StatusCode.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated at Wed Feb 9 16:31:53 2011 for Gaudi Framework, version v22r0 by Doxygen version 1.6.2 written by Dimitri van Heesch, © 1997-2004