#include <GaudiTools/IErrorTool.h>

Inheritance diagram for IErrorTool:

Collaboration diagram for IErrorTool:

Public Member Functions
	DeclareInterfaceID (IErrorTool, 2, 0)
	InterfaceID. More...

virtual StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const =0
	Print the error message, return status code and perform the statistics of error messages. More...

virtual StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const =0
	Print the warning message, return status code and perform the statistics of warning messages. More...

virtual StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const =0
	Print the message and return status code. More...

virtual void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode::FAILURE) const =0
	Assertion - throw exception, if condition is not fulfilled. More...

virtual void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode::FAILURE) const =0
	Create and (re)-throw the exception. More...

virtual void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode::FAILURE) const =0
	Create and (re)-throw the exception. More...

virtual void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode::FAILURE) const =0
	Create and throw the exception. More...

	DeclareInterfaceID (IErrorTool, 2, 0)
	InterfaceID. More...

virtual StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const =0
	Print the error message, return status code and perform the statistics of error messages. More...

virtual StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const =0
	Print the warning message, return status code and perform the statistics of warning messages. More...

virtual StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const =0
	Print the message and return status code. More...

virtual void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode::FAILURE) const =0
	Assertion - throw exception, if condition is not fulfilled. More...

virtual void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode::FAILURE) const =0
	Create and (re)-throw the exception. More...

virtual void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode::FAILURE) const =0
	Create and (re)-throw the exception. More...

virtual void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode::FAILURE) const =0
	Create and throw the exception. More...

Public Member Functions inherited from IAlgTool
	DeclareInterfaceID (IAlgTool, 4, 0)
	InterfaceID. More...

	~IAlgTool () override=default
	Virtual destructor. More...

virtual const std::string &	type () const =0
	The type of an AlgTool, meaning the concrete AlgTool class. More...

virtual const IInterface *	parent () const =0
	The parent of the concrete AlgTool. More...

virtual StatusCode	sysInitialize ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysStart ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysStop ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysFinalize ()=0
	Finalization of the Tool. More...

virtual StatusCode	sysReinitialize ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysRestart ()=0
	Initialization of the Tool. More...

	DeclareInterfaceID (IAlgTool, 4, 0)
	InterfaceID. More...

	~IAlgTool () override=default
	Virtual destructor. More...

virtual const std::string &	type () const =0
	The type of an AlgTool, meaning the concrete AlgTool class. More...

virtual const IInterface *	parent () const =0
	The parent of the concrete AlgTool. More...

virtual StatusCode	sysInitialize ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysStart ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysStop ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysFinalize ()=0
	Finalization of the Tool. More...

virtual StatusCode	sysReinitialize ()=0
	Initialization of the Tool. More...

virtual StatusCode	sysRestart ()=0
	Initialization of the Tool. More...

Public Member Functions inherited from extend_interfaces< Interfaces >
	~extend_interfaces () override=default
	Virtual destructor. More...

	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Member Functions
virtual	~IErrorTool ()=default

virtual	~IErrorTool ()=default

Additional Inherited Members
Public Types inherited from extend_interfaces< Interfaces >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Author: Ivan BELYAEV

Date: 2004-06-28

Definition at line 24 of file IErrorTool.h.

Constructor & Destructor Documentation

virtual IErrorTool::~IErrorTool ( )

protectedvirtualdefault

virtual IErrorTool::~IErrorTool ( )

protectedvirtualdefault

Member Function Documentation

virtual void IErrorTool::Assert	(	const bool	ok,
		const std::string &	message = `""`,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Assertion - throw exception, if condition is not fulfilled.

See also: CaloException; GaudiException

Exceptions

CaloException for invalid condition

Parameters

ok	condition which should be "true"
message	message to be associated with the exception
sc	status code to be returned (artificial)

Returns: status code

Implemented in ErrorTool.

virtual void IErrorTool::Assert	(	const bool	ok,
		const std::string &	message = `""`,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Assertion - throw exception, if condition is not fulfilled.

See also: CaloException; GaudiException

Exceptions

CaloException for invalid condition

Parameters

ok	condition which should be "true"
message	message to be associated with the exception
sc	status code to be returned (artificial)

Returns: status code

Implemented in ErrorTool.

IErrorTool::DeclareInterfaceID	(	IErrorTool	,
		2	,
		0
	)

InterfaceID.

IErrorTool::DeclareInterfaceID	(	IErrorTool	,
		2	,
		0
	)

InterfaceID.

virtual StatusCode IErrorTool::Error	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::FAILURE`,
		const size_t	mx = `10`
	)		const

pure virtual

Print the error message, return status code and perform the statistics of error messages.

IErrorTool* tool = .. ;
 if( a < 0 ) { return tool->Error(" 'a' is negative!") ;}
 if( b < 0 ) { return tool->Error(" 'b' is illegal!" , StatusCode(25) );
 if( c < 0 )
    { return tool->Error(" 'c' is negative" , StatusCode(35) , 50 );

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	error message
st	status code
mx	maximal number of printouts

Returns: status code

Implemented in ErrorTool.

virtual StatusCode IErrorTool::Error	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::FAILURE`,
		const size_t	mx = `10`
	)		const

pure virtual

Print the error message, return status code and perform the statistics of error messages.

IErrorTool* tool = .. ;
 if( a < 0 ) { return tool->Error(" 'a' is negative!") ;}
 if( b < 0 ) { return tool->Error(" 'b' is illegal!" , StatusCode(25) );
 if( c < 0 )
    { return tool->Error(" 'c' is negative" , StatusCode(35) , 50 );

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	error message
st	status code
mx	maximal number of printouts

Returns: status code

Implemented in ErrorTool.

virtual void IErrorTool::Exception	(	const std::string &	msg,
		const GaudiException &	exc,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Create and (re)-throw the exception.

See also: GaudiException

Exceptions

CaudiException always!

Parameters

msg	exception message
exc	(previous) exception of type GaudiException
sc	status code

Returns: status code (fictive)

Implemented in ErrorTool.

virtual void IErrorTool::Exception	(	const std::string &	msg,
		const GaudiException &	exc,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Create and (re)-throw the exception.

See also: GaudiException

Exceptions

CaudiException always!

Parameters

msg	exception message
exc	(previous) exception of type GaudiException
sc	status code

Returns: status code (fictive)

Implemented in ErrorTool.

virtual void IErrorTool::Exception	(	const std::string &	msg,
		const std::exception &	exc,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Create and (re)-throw the exception.

See also: GaudiException

Exceptions

GaudiException always!

Parameters

msg	exception message
exc	(previous) exception of type std::exception
sc	status code

Returns: status code (fictive)

Implemented in ErrorTool.

virtual void IErrorTool::Exception	(	const std::string &	msg,
		const std::exception &	exc,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Create and (re)-throw the exception.

See also: GaudiException

Exceptions

GaudiException always!

Parameters

msg	exception message
exc	(previous) exception of type std::exception
sc	status code

Returns: status code (fictive)

Implemented in ErrorTool.

virtual void IErrorTool::Exception	(	const std::string &	msg = `"no message"`,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Create and throw the exception.

See also: GaudiException

Exceptions

GaudiException always!

Parameters

msg	exception message
sc	status code

Returns: status code (fictive)

Implemented in ErrorTool.

virtual void IErrorTool::Exception	(	const std::string &	msg = `"no message"`,
		const StatusCode	sc = `StatusCode::FAILURE`
	)		const

pure virtual

Create and throw the exception.

See also: GaudiException

Exceptions

GaudiException always!

Parameters

msg	exception message
sc	status code

Returns: status code (fictive)

Implemented in ErrorTool.

virtual StatusCode IErrorTool::Print	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::SUCCESS`,
		const MSG::Level	lev = `MSG::INFO`
	)		const

pure virtual

Print the message and return status code.

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	warning message
st	status code
lev	print level

Returns: status code

Implemented in ErrorTool.

virtual StatusCode IErrorTool::Print	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::SUCCESS`,
		const MSG::Level	lev = `MSG::INFO`
	)		const

pure virtual

Print the message and return status code.

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	warning message
st	status code
lev	print level

Returns: status code

Implemented in ErrorTool.

virtual StatusCode IErrorTool::Warning	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::FAILURE`,
		const size_t	mx = `10`
	)		const

pure virtual

Print the warning message, return status code and perform the statistics of warning messages.

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	warning message
st	statsu code
mx	maximal number of printouts

Returns: status code

Implemented in ErrorTool.

virtual StatusCode IErrorTool::Warning	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::FAILURE`,
		const size_t	mx = `10`
	)		const

pure virtual

Print the warning message, return status code and perform the statistics of warning messages.

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	warning message
st	statsu code
mx	maximal number of printouts

Returns: status code

Implemented in ErrorTool.

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

InstallArea/x86_64-slc6-gcc48-opt/include/GaudiAlg/IErrorTool.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation