---

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 }
Public Methods
	StatusCode ( unsigned long code = SUCCESS )
	Constructor. More...
bool	isSuccess () const
	Test for a status code of SUCCESS. More...
bool	isFailure () const
	Test for a status code of FAILURE. More...
unsigned long	getCode () const
	Get the status code by value. More...
void	setCode ( unsigned long )
	Set the status code by value. More...
	operator unsigned long () const
	Cast operator. More...
StatusCode&	operator= (unsigned long value)
	Assignment operator. More...
Protected Attributes
unsigned long	d_code
	The status code. More...
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(s):

Iain Last , Pere Mato

Definition at line 13 of file StatusCode.h.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: FAILURE   SUCCESS   Definition at line 15 of file StatusCode.h.

---

Constructor & Destructor Documentation

StatusCode::StatusCode ( unsigned long code = SUCCESS ) [inline]

Constructor. Definition at line 58 of file StatusCode.h.

---

Member Function Documentation

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

Get the status code by value. Definition at line 69 of file StatusCode.h. Referenced by DataSvc::registerObject().

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 staus codes. To test for any failure use : if ( !StatusCode.isSuccess() ) ... Definition at line 65 of file StatusCode.h. Referenced by Algorithm::auditorSvc(), Algorithm::chronoSvc(), Gaudi::createApplicationMgrEx(), Algorithm::createSubAlgorithm(), Algorithm::detCnvSvc(), Algorithm::detSvc(), Algorithm::eventCnvSvc(), Algorithm::eventSvc(), Algorithm::histoSvc(), Service::initialize(), Converter::initialize(), Algorithm::msgSvc(), Algorithm::ntupleSvc(), Algorithm::randSvc(), Algorithm::sysExecute(), and Algorithm::sysInitialize().

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 61 of file StatusCode.h. Referenced by AlgTool::AlgTool(), SmartRefBase::accessData(), Gaudi::createInstance(), ConversionSvc::createObj(), ConversionSvc::createReps(), SmartDataObjectPtr::findObject(), DataSvc::findObject(), Gaudi::getFactory(), Rndm::Numbers::initialize(), ConversionSvc::initialize(), isValidInterface(), DataSvc::linkObject(), DataSvc::loadObject(), NTuple::Selector::operator()(), DataSvc::preLoad(), DataSvc::registerObject(), DataSvc::retrieveEntry(), SmartDataObjectPtr::retrieveObject(), DataSvc::retrieveObject(), IToolSvc::retrieveTool(), Service::service(), Auditor::service(), Algorithm::service(), Service::setProperties(), Auditor::setProperties(), Algorithm::setProperties(), Gaudi::svcLocator(), Auditor::sysFinalize(), Algorithm::sysFinalize(), Auditor::sysInitialize(), ConversionSvc::updateObj(), SmartDataObjectPtr::updateObject(), DataSvc::updateObject(), and ConversionSvc::updateReps().

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

Cast operator. Definition at line 77 of file StatusCode.h.

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

Assignment operator. Definition at line 81 of file StatusCode.h.

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

Set the status code by value. Definition at line 73 of file StatusCode.h.

---

Friends And Related Function Documentation

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

Comparison operator. Definition at line 86 of file StatusCode.h.

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

Comparison operator. Definition at line 90 of file StatusCode.h.

---

Member Data Documentation

unsigned long StatusCode::d_code [protected]

The status code. Definition at line 55 of file StatusCode.h.

---

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

• StatusCode.h

---