ErrorTool Class Reference

#include <components/ErrorTool.h>

Inheritance diagram for ErrorTool:

Collaboration diagram for ErrorTool:

Public Member Functions
	ErrorTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const override
	Print the error message, return status code and perform the statistics of error messages. More...
StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const override
	Print the warning message, return status code and perform the statistics of warning messages. More...
StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const override
	Print the message and return status code. More...
void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode::FAILURE) const override
	Assertion - throw exception, if condition is not fulfilled. More...
void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode::FAILURE) const override
	Create and (re)-throw the exception. More...
void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode::FAILURE) const override
	Create and (re)-throw the exception. More...
void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode::FAILURE) const override
	Create and throw the exception. More...
Public Member Functions inherited from GaudiTool
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
INTupleSvc *	ntupleSvc () const
	Access the standard N-Tuple. More...
INTupleSvc *	evtColSvc () const
	Access the standard event collection service. More...
IDataProviderSvc *	detSvc () const
	accessor to detector service More...
IIncidentSvc *	incSvc () const
	accessor to Incident Service More...
IChronoStatSvc *	chronoSvc () const
	accessor to Chrono & Stat Service More...
IHistogramSvc *	histoSvc () const
	acessor to the histogram service More...
IAlgContextSvc *	contextSvc () const
	acessor to the Algorithm Context Service More...
void	put (IDataProviderSvc *svc, DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
void	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const
const DataObject *	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
const DataObject *	put (std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data from Gaudi Event Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
TYPE *	getDet (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
template<class TYPE >
bool	exist (const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
template<class TYPE >
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...
template<class TYPE >
bool	existDet (const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...
StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...
StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...
	GaudiTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
	~GaudiTool () override
	destructor, virtual and protected More...
Public Member Functions inherited from GaudiCommon< CounterHolder< AlgTool > >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Quicker version of the get function which bypasses the check on the retrieved data. More...
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
DataObject *	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, const std::string &location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
DataObject *	put (IDataProviderSvc *svc, DataObject *object, const std::string &location, const bool useRootInTES=true) const
TOOL *	tool (const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools. More...
TOOL *	tool (const std::string &type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...
SmartIF< SERVICE >	svc (const std::string &name, const bool create=true) const
	A useful method for the easy location of services. More...
IUpdateManagerSvc *	updMgrSvc () const
	Short-cut to locate the Update Manager Service. More...
WARN_UNUSED StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...
WARN_UNUSED StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...
WARN_UNUSED StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...
WARN_UNUSED StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
	Print the message and return with the given StatusCode. More...
void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...
void	Assert (const bool ok, const char *message, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...
void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException. More...
void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception. More...
void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message. More...
StatEntity &	counter (const std::string &tag) const
	accessor to certain counter by name More...
StatEntity &	counter (const std::string &tag)
bool	typePrint () const
	Insert the actual C++ type of the algorithm/tool in the messages ? More...
bool	propsPrint () const
	Print properties at initialization ? More...
bool	statPrint () const
	Print statistical counters at finalization ? More...
bool	errorsPrint () const
	Print error counters at finalization ? More...
long	printStat (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of statistical counters More...
long	printErrors (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of error counters More...
long	printProps (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of properties More...
void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=nullptr)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
void	registerCondition (const std::string &condition, CondType *&condPtrDest, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
void	registerCondition (char *condition, StatusCode(CallerClass::*mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class. More...
void	registerCondition (TargetClass *condition, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
StatusCode	runUpdate ()
	asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident. More...
	GaudiCommon (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from Algorithm. More...
	GaudiCommon (const std::string &type, const std::string &name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
StatusCode	release (const IInterface *interface) const
	Manual forced (and 'safe') release of the active tool or service. More...
const Services &	services () const
	get the list of aquired services More...
const std::string &	context () const
	Returns the "context" string. Used to identify different processing states. More...
const std::string &	rootInTES () const
	Returns the "rootInTES" string. More...
const std::string	fullTESLocation (const std::string &location, const bool useRootInTES) const
	Returns the full correct event location given the rootInTes settings. More...
Public Member Functions inherited from CounterHolder< BASE >
void	declareCounter (const std::string &tag, Gaudi::Accumulators::PrintableCounter &r)
const Gaudi::Accumulators::PrintableCounter *	findCounter (const std::string &tag) const
template<typename Callable >
void	forEachCounter (Callable &&f) const
int	nCounters () const
void	clearCounters ()
Public Member Functions inherited from IErrorTool
	DeclareInterfaceID (IErrorTool, 2, 0)
	InterfaceID. More...
Public Member Functions inherited from IAlgTool
	DeclareInterfaceID (IAlgTool, 4, 0)
	InterfaceID. 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	configure ()=0
	Configuration (from OFFLINE to CONFIGURED). More...
virtual StatusCode	initialize ()=0
	Initialization (from CONFIGURED to INITIALIZED). More...
virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING). More...
virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED). More...
virtual StatusCode	finalize ()=0
	Finalize (from INITIALIZED to CONFIGURED). More...
virtual StatusCode	terminate ()=0
	Initialization (from CONFIGURED to OFFLINE). More...
virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state. 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 INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...
virtual const std::string &	name () const =0
	Retrieve the name of the instance. More...
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	release ()=0
	Release Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...
virtual	~IInterface ()=default
	Virtual destructor. More...

Additional Inherited Members
Public Types inherited from IInterface
enum	Status : StatusCode::code_t {   Status::FAILURE = 0, Status::SUCCESS = 1, Status::NO_INTERFACE, Status::VERSMISMATCH,   Status::LAST_ERROR }
	Return status. More...
using	iid = Gaudi::InterfaceId< IInterface, 0, 0 >
	Interface ID. More...
using	ext_iids = Gaudi::interface_list< iid >
	Extra interfaces. More...
Static Public Member Functions inherited from GaudiTool
static bool	enableSummary (bool)
	enable/disable summary More...
static bool	summaryEnabled ()
	is summary enabled? More...
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...
Protected Types inherited from GaudiCommon< CounterHolder< AlgTool > >
using	base_class = CounterHolder< AlgTool >
typedef std::map< std::string, StatEntity >	StatisticsOwn
	the actual type of general counters More...
typedef std::map< std::string, std::reference_wrapper< Gaudi::Accumulators::PrintableCounter > >	Statistics
typedef std::map< std::string, unsigned int >	Counter
	the actual type error/warning counter More...
typedef std::vector< IAlgTool * >	AlgTools
	storage for active tools More...
typedef std::vector< SmartIF< IService > >	Services
	storage for active services More...
Protected Member Functions inherited from GaudiCommon< CounterHolder< AlgTool > >
StatusCode	releaseTool (const IAlgTool *tool) const
	manual forced (and 'safe') release of the tool More...
StatusCode	releaseSvc (const IInterface *svc) const
	manual forced (and 'safe') release of the service More...
Protected Member Functions inherited from IErrorTool
virtual	~IErrorTool ()=default
Protected Attributes inherited from GaudiCommon< CounterHolder< AlgTool > >
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...
Static Protected Attributes inherited from GaudiCommon< CounterHolder< AlgTool > >
static const bool	IgnoreRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...
static const bool	UseRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

Detailed Description

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru

Date

2004-06-28

Definition at line 21 of file ErrorTool.h.

Constructor & Destructor Documentation

ErrorTool::ErrorTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard constructor.

See also

GaudiTool

AlgTool

Parameters

type	tool type (?)
name	tool name
parent	pointer to parent component

Definition at line 32 of file ErrorTool.cpp.

    : GaudiTool( type, name, parent ) {
  declareInterface<IErrorTool>( this );
}

Member Function Documentation

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

inlineoverridevirtual

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

Implements IErrorTool.

Definition at line 98 of file ErrorTool.h.

                                                                        {
    GaudiTool::Assert( ok, message, sc );
  }

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

inlineoverridevirtual

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

Implements IErrorTool.

Definition at line 55 of file ErrorTool.h.

                                                          {
    return GaudiTool::Error( msg, st, mx );
  }

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

inlineoverridevirtual

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)

Implements IErrorTool.

Definition at line 111 of file ErrorTool.h.

                                                                           {
    GaudiTool::Exception( msg, exc, sc );
  }

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

inlineoverridevirtual

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)

Implements IErrorTool.

Definition at line 124 of file ErrorTool.h.

                                                                           {
    GaudiTool::Exception( msg, exc, sc );
  }

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

inlineoverridevirtual

Create and throw the exception.

See also

GaudiException

Exceptions

GaudiException

always!

Parameters

msg	exception message
sc	status code

Returns

status code (fictive)

Implements IErrorTool.

Definition at line 136 of file ErrorTool.h.

                                                                                                                {
    GaudiTool::Exception( msg, sc );
  }

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

inlineoverridevirtual

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

Implements IErrorTool.

Definition at line 84 of file ErrorTool.h.

                                                                  {
    return GaudiTool::Print( msg, st, lev );
  }

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

inlineoverridevirtual

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

Implements IErrorTool.

Definition at line 70 of file ErrorTool.h.

                                                            {
    return GaudiTool::Warning( msg, st, mx );
  }

---

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

• GaudiAlg/src/components/ErrorTool.h
• GaudiAlg/src/components/ErrorTool.cpp