The useful base class for tools. More...

#include <GaudiTools/GaudiTool.h>

Inheritance diagram for GaudiTool:

[legend]

Collaboration diagram for GaudiTool:

[legend]

Public Member Functions
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 ()

Static Public Member Functions
static bool	enableSummary (bool)
	enable/disable summary More...

static bool	summaryEnabled ()
	is summary enabled? More...

Private Member Functions
	GaudiTool ()=delete
	no default/copy constructor, no assignment More...

	GaudiTool (const GaudiTool &)=delete

GaudiTool &	operator= (const GaudiTool &)=delete

bool	isPublic () const
	Determines if this tool is public or not (i.e. owned by the ToolSvc). More...

std::string	getCurrentAlgName () const
	Returns the current active algorithm name via the context service. More...

Private Attributes
SmartIF< INTupleSvc >	m_ntupleSvc
	pointer to the N-Tuple service More...

SmartIF< INTupleSvc >	m_evtColSvc
	pointer to the event tag collection service More...

SmartIF< IDataProviderSvc >	m_detSvc
	pointer to Detector Data Service More...

SmartIF< IChronoStatSvc >	m_chronoSvc
	pointer to Chrono & Stat Service More...

SmartIF< IIncidentSvc >	m_incSvc
	pointer to Incident Service More...

SmartIF< IHistogramSvc >	m_histoSvc
	pointer for histogram service More...

SmartIF< IAlgContextSvc >	m_contextSvc
	Algorithm Context Service. More...

Gaudi::Property< std::string >	m_contextSvcName

bool	m_isPublic = false
	Flag to say if the tool is a public or private tool. More...

const std::string	m_local
	full tool name "type/name" More...

Static Private Attributes
static bool	s_enableSummary = true
	enable printout of summary? More...

Additional Inherited Members
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 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

The useful base class for tools.

Small extension of ordinary the AlgTool base class.

This base class allows "easy"(=="1 line") access to tools and services. This access is safe in the sense that there is no need to worry about the reference counts for tools and services.

The base class allows "easy" (=="1 line") access to data in Gaudi Transient Stores. The functionality includes the checking of the presence of the data at the given location, checking the validity of the data, retrieval of valid data and "forced" retrieve of valid data (create if there is no data).

The base class allows to perform an easy error, warning and exception treatments, including the accumulated statistics of exceptions, errors and warnings.

The base class also includes utilities for general statistical counters.

It has been reported that usage of this base class results in significant reduction of existing code lines.

Attention: See the class GaudiCommon, which implements some of the common functionality between GaudiTool and GaudiAlgorithm

Author: Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru; Chris Jones Chris.nosp@m.toph.nosp@m.er.Ro.nosp@m.b.Jo.nosp@m.nes@c.nosp@m.ern..nosp@m.ch

Date: 2003-07-07

Definition at line 101 of file GaudiTool.h.

Constructor & Destructor Documentation

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

Standard constructor.

See also: AlgTool

Parameters

type	tool type (useless)
name	tool name
parent	pointer to parent object (service, algorithm or tool)

Definition at line 132 of file GaudiTool.cpp.

     : GaudiCommon<CounterHolder<AlgTool>>( this_type, this_name, parent ), m_local( this_type + "/" + this_name ) {
   // make instance counts
   GaudiToolLocal::s_InstanceCounter.increment( m_local );
 }

GaudiTool::~GaudiTool ( )

override

destructor, virtual and protected

Definition at line 140 of file GaudiTool.cpp.

140 { GaudiToolLocal::s_InstanceCounter.decrement( m_local ); }

GaudiTool::m_local

const std::string m_local

full tool name "type/name"

Definition: GaudiTool.h:779

GaudiTool::GaudiTool ( )

privatedelete

no default/copy constructor, no assignment

GaudiTool::GaudiTool ( const GaudiTool & )

privatedelete

Member Function Documentation

IChronoStatSvc * GaudiTool::chronoSvc ( ) const

accessor to Chrono & Stat Service

Returns: pointer to the Chrono & Stat Service

Definition at line 227 of file GaudiTool.cpp.

                                            {
   if ( UNLIKELY( !m_chronoSvc ) ) m_chronoSvc = service( GaudiToolServices::s_ChronoStatSvc, true );
   return m_chronoSvc;
 }

IAlgContextSvc * GaudiTool::contextSvc ( ) const

acessor to the Algorithm Context Service

Returns: pointer to the Algorithm Context Service

Definition at line 241 of file GaudiTool.cpp.

                                             {
   if ( UNLIKELY( !m_contextSvc ) ) m_contextSvc = service( m_contextSvcName, true );
   return m_contextSvc;
 }

IDataProviderSvc * GaudiTool::detSvc ( ) const

accessor to detector service

Returns: pointer to detector service

Definition at line 199 of file GaudiTool.cpp.

                                           {
   if ( UNLIKELY( !m_detSvc ) ) m_detSvc = service( GaudiToolServices::s_DetectorDataSvc, true );
   return m_detSvc;
 }

bool GaudiTool::enableSummary ( bool value )

static

enable/disable summary

Definition at line 117 of file GaudiTool.cpp.

 {
   s_enableSummary = value;
   return summaryEnabled();
 }

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

inline

Print the error message and return with the given StatusCode.

Also performs statistical analysis of the error messages and suppression after the defined number of error instances.

if( a < 0 ) { return Error("a is negative!") ;}
if( b < 0 ) { return Error("b is illegal!" , StatusCode(25) );
if( c < 0 )
   { return Error("c is negative" , StatusCode(35) , 50 );

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	Error message
st	StatusCode to return
mx	Maximum number of printouts for this message

Returns: StatusCode

Definition at line 663 of file GaudiTool.h.

                                                         {
     return GaudiCommon<CounterHolder<AlgTool>>::Error( m_isPublic ? msg + getCurrentAlgName() : msg, st, mx );
   }

INTupleSvc * GaudiTool::evtColSvc ( ) const

Access the standard event collection service.

Returns: pointer to the event collection service

Definition at line 213 of file GaudiTool.cpp.

                                        {
   if ( UNLIKELY( !m_evtColSvc ) ) m_evtColSvc = service( "EvtTupleSvc", true );
   return m_evtColSvc;
 }

template<class TYPE >

bool GaudiTool::exist	(	IDataProviderSvc *	svc,
		const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Check the existence of a data object or container in the Gaudi Transient Event Store.

bool a1 = exist<DataObject>( evtSvc(), "/Event/MyObject" ) ;

bool a2 = exist<MyHits> ( evtSvc(), "/Event/MyHits" ) ;

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

Parameters

svc	Pointer to data service (data provider)
location	Address in Gaudi Transient Event Store
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns: Boolean indicating status of the request

Return values

true	Data object or container exists and implements a proper interface
true	Failed to locate the data object or container

Definition at line 503 of file GaudiTool.h.

                                                                                                               {
     return GaudiCommon<CounterHolder<AlgTool>>::exist<TYPE>( svc, location, useRootInTES );
   }

template<class TYPE >

bool GaudiTool::exist	(	const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Check the existence of a data object or container in the Gaudi Transient Event Store.

bool a1 = exist<DataObject>( "/Event/MyObject" ) ;

bool a2 = exist<MyHits> ( "/Event/MyHits" ) ;

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

Parameters

location Address in Gaudi Transient Event Store

Returns: Boolean indicating status of the request

Return values

true	Data object or container exists and implements a proper interface
true	Failed to locate the data object or container

Definition at line 530 of file GaudiTool.h.

                                                                                        {
     return GaudiCommon<CounterHolder<AlgTool>>::exist<TYPE>( evtSvc(), location, useRootInTES );
   }

template<class TYPE >

bool GaudiTool::existDet	(	IDataProviderSvc *	svc,
		const std::string &	location
	)		const

inline

Check the existence of detector objects in the Gaudi Transient Detector Store.

bool a1 = existDet<DataObject> ( detSvc(), "/dd/Structure/MyObject" ) ;

bool a2 = existDet<Material> ( detSvc(), "/dd/Structure/Material/Air" ) ;

Parameters

svc	Pointer to data service (data provider)
location	Address in Gaudi Transient Detector Store

Returns: Boolean indicating status of the request

Return values

true	Detector object exists and implements a proper interface
false	Failed to locate the data object

Definition at line 551 of file GaudiTool.h.

                                                                                  {
     return GaudiCommon<CounterHolder<AlgTool>>::exist<TYPE>( svc, location, false );
   }

template<class TYPE >

bool GaudiTool::existDet ( const std::string & location ) const

inline

Check the existence of detector objects in the Gaudi Transient Detector Store.

bool a1 = existDet<DataObject> ( "/dd/Structure/MyObject" ) ;

bool a2 = existDet<Material> ( "/dd/Structure/Material/Air" ) ;

Parameters

location Address in Gaudi Transient Detector Store

Returns: Boolean indicating status of the request

Return values

true	Detector object exists and implements a proper interface
false	Failed to locate the data object

Definition at line 571 of file GaudiTool.h.

                                                           {
     return GaudiCommon<CounterHolder<AlgTool>>::exist<TYPE>( detSvc(), location, false );
   }

StatusCode GaudiTool::finalize ( )

override

standard finalization method

See also: AlgTool; IAlgTool

Returns: status code

Definition at line 161 of file GaudiTool.cpp.

                                {
   if ( msgLevel( MSG::DEBUG ) ) debug() << " ==> Finalize the base class GaudiTool " << endmsg;
 
   // clear "explicit services"
   m_detSvc.reset();
   m_chronoSvc.reset();
   m_incSvc.reset();
   m_histoSvc.reset();
 
   // finalize the base class
   const StatusCode sc = GaudiCommon<CounterHolder<AlgTool>>::finalize();
   if ( sc.isFailure() ) { return sc; }
 
   // Decrement the counter
   GaudiToolLocal::s_FinalizeCounter.decrement( m_local );
 
   // return
   return sc;
 }

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::get	(	IDataProviderSvc *	svc,
		const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Templated access to the data in Gaudi Transient Store.

Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data

MCHits* hits = get<MCHits>( evtSvc() , "/Event/MC/Hits" );

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

See also: IDataProviderSvc; SmartDataPtr

Exceptions

GaudiException	for Invalid Data Provider Service
GaudiException	for invalid/unavailable data

Parameters

svc	Pointer to data service (data provider)
location	data location/address in Gaudi Transient Store
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns: pointer to the data object

Definition at line 265 of file GaudiTool.h.

                                                                                                        {
     return GaudiCommon<CounterHolder<AlgTool>>::get<TYPE>( svc, location, useRootInTES );
   }

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::get	(	const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Templated access to the data from Gaudi Event Transient Store.

Quick and safe access to the data in Gaudi transient store.

The method located the data at the given address and perform the debug printout about located data.

MCParticles* mcps = get<MCParticles>( MCParticleLocation::Default );

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

Parameters

location	Data location/address in Gaudi Transient Store
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns: Pointer to the data object

Definition at line 335 of file GaudiTool.h.

                                                                                                                {
     return GaudiCommon<CounterHolder<AlgTool>>::get<TYPE>( evtSvc(), location, useRootInTES );
   }

std::string GaudiTool::getCurrentAlgName ( ) const

inlineprivate

Returns the current active algorithm name via the context service.

Definition at line 745 of file GaudiTool.h.

                                              {
     const IAlgContextSvc* asvc    = this->contextSvc();
     const IAlgorithm*     current = ( asvc ? asvc->currentAlg() : NULL );
     return ( current ? " [" + current->name() + "]" : "" );
   }

template<class TYPE >

TYPE* GaudiTool::getDet	(	IDataProviderSvc *	svc,
		const std::string &	location
	)		const

inline

Templated access to the detector data from the Gaudi Detector Transient Store.

Quick and safe access to the detector data in Gaudi transient store.

The method located the detector at the given address and perform the debug printout about located detector.

MyDet* mdet = getDet<MyDet>( detSvc() , "/dd/Structure/LHCb/MyDet" );

Parameters

svc	Pointer to data service (data provider)
location	Detector location/address in Gaudi Transient Store

Returns: Pointer to the detector object

Definition at line 397 of file GaudiTool.h.

                                                                                 {
     return GaudiCommon<CounterHolder<AlgTool>>::get<TYPE>( svc, location, false );
   }

template<class TYPE >

TYPE* GaudiTool::getDet ( const std::string & location ) const

inline

Templated access to the detector data from the Gaudi Detector Transient Store.

Quick and safe access to the detector data in Gaudi transient store.

The method located the detector at the given address and perform the debug printout about located detector.

MyDet* mdet = getDet<MyDet>( "/dd/Structure/LHCb/MyDet" );

Parameters

location Detector location/address in Gaudi Transient Store

Returns: Pointer to the detector object

Definition at line 447 of file GaudiTool.h.

                                                          {
     return GaudiCommon<CounterHolder<AlgTool>>::get<TYPE>( detSvc(), location, false );
   }

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getDetIfExists	(	IDataProviderSvc *	svc,
		const std::string &	location
	)		const

inline

Templated access to the detector data from the Gaudi Detector Transient Store.

Quick and safe access to the detector data in Gaudi transient store.

The method located the detector at the given address and perform the debug printout about located detector.

Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.

MyDet* mdet = getDetIfExists<MyDet>( detSvc() , "/dd/Structure/LHCb/MyDet" );

Parameters

svc	Pointer to data service (data provider)
location	Detector location/address in Gaudi Transient Store

Returns: Pointer to the detector object

Return values

NULL	If the detector object does not exist.

Definition at line 424 of file GaudiTool.h.

                                                                                                              {
     return GaudiCommon<CounterHolder<AlgTool>>::getIfExists<TYPE>( svc, location, false );
   }

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getDetIfExists ( const std::string & location ) const

inline

Templated access to the detector data from the Gaudi Detector Transient Store.

Quick and safe access to the detector data in Gaudi transient store.

The method located the detector at the given address and perform the debug printout about located detector.

Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.

MyDet* mdet = getDetIfExists<MyDet>( "/dd/Structure/LHCb/MyDet" );

Parameters

location Detector location/address in Gaudi Transient Store

Returns: Pointer to the detector object

Return values

NULL	If the detector object does not exist.

Definition at line 473 of file GaudiTool.h.

                                                                                                        {
     return GaudiCommon<CounterHolder<AlgTool>>::getIfExists<TYPE>( detSvc(), location, false );
   }

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getIfExists	(	IDataProviderSvc *	svc,
		const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Templated access to the data in Gaudi Transient Store.

Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data.

Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.

MCHits* hits = getIfExists<MCHits>( evtSvc() , "/Event/MC/Hits" );

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

See also: IDataProviderSvc; SmartDataPtr

Parameters

svc	Pointer to data service (data provider)
location	data location/address in Gaudi Transient Store
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns: pointer to the data object.

Return values

NULL	If data does not exist.

Definition at line 305 of file GaudiTool.h.

                                                                                                         {
     return GaudiCommon<CounterHolder<AlgTool>>::getIfExists<TYPE>( svc, location, useRootInTES );
   }

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getIfExists	(	const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Templated access to the data in Gaudi Transient Store.

Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data.

Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.

MCHits* hits = getIfExists<MCHits>( "/Event/MC/Hits" );

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

See also: IDataProviderSvc; SmartDataPtr

Parameters

location	data location/address in Gaudi Transient Store
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns: pointer to the data object.

Return values

NULL	If data does not exist.

Definition at line 373 of file GaudiTool.h.

                                                                                                                        {
     return GaudiCommon<CounterHolder<AlgTool>>::getIfExists<TYPE>( evtSvc(), location, useRootInTES );
   }

template<class TYPE , class TYPE2 >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getOrCreate	(	IDataProviderSvc *	svc,
		const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Get the existing data object from Gaudi Event Transient store.

Alternatively, create new object and register it in TES and return if object does not exist.

MyHits* hits = getOrCreate<MyHits,MyHits>( evtSvc() , "/Event/MyHits" ) ;

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

Exceptions

GaudiException	for Invalid Data Provider Service
GaudiException	for invalid/unavailable data

Parameters

svc	Pointer to data service (data provider)
location	Location in Gaudi Transient Event Store
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns: A valid pointer to the object

Definition at line 603 of file GaudiTool.h.

                                                                                                         {
     return GaudiCommon<CounterHolder<AlgTool>>::getOrCreate<TYPE, TYPE2>( svc, location, useRootInTES );
   }

template<class TYPE , class TYPE2 >

Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getOrCreate	(	const std::string &	location,
		const bool	useRootInTES = `true`
	)		const

inline

Get the existing data object from Gaudi Event Transient store.

Alternatively, create new object and register it in TES and return if object does not exist.

MyHits* hits = getOrCreate<MyHits,MyHits>( "/Event/MyHits" ) ;

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

Exceptions

GaudiException	for Invalid Data Provider Service
GaudiException	for invalid/unavailable data

Parameters

location	Location in Gaudi Transient Event Store
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns: A valid pointer to the object

Definition at line 633 of file GaudiTool.h.

                                                                                                                        {
     return GaudiCommon<CounterHolder<AlgTool>>::getOrCreate<TYPE, TYPE2>( evtSvc(), location, useRootInTES );
   }

IHistogramSvc * GaudiTool::histoSvc ( ) const

acessor to the histogram service

Returns: pointer to the histogram service

Definition at line 234 of file GaudiTool.cpp.

                                          {
   if ( UNLIKELY( !m_histoSvc ) ) m_histoSvc = service( GaudiToolServices::s_HistoSvc, true );
   return m_histoSvc;
 }

IIncidentSvc * GaudiTool::incSvc ( ) const

accessor to Incident Service

Returns: pointer to the Incident Service

Definition at line 220 of file GaudiTool.cpp.

                                       {
   if ( UNLIKELY( !m_incSvc ) ) m_incSvc = service( GaudiToolServices::s_IncidentSvc, true );
   return m_incSvc;
 }

StatusCode GaudiTool::Info	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::SUCCESS`,
		const size_t	mx = `10`
	)		const

inline

Print the info message and return with the given StatusCode.

Also performs statistical analysis of the info messages and suppression after the defined number of instances.

See also: MsgStream; IMessageSvc; StatusCode; GaudiCommon::Warning

Parameters

msg	Info message
st	StatusCode to return
mx	Maximum number of printouts for this message

Returns: The given StatusCode

Definition at line 709 of file GaudiTool.h.

                                                        {
     return GaudiCommon<CounterHolder<AlgTool>>::Info( m_isPublic ? msg + getCurrentAlgName() : msg, st, mx );
   }

StatusCode GaudiTool::initialize ( )

override

standard initialization method

See also: AlgTool; IAlgTool

Returns: status code

Definition at line 144 of file GaudiTool.cpp.

                                  {
   // initialize the base class
   const StatusCode sc = GaudiCommon<CounterHolder<AlgTool>>::initialize();
   if ( sc.isFailure() ) { return sc; }
 
   // increment the counter
   GaudiToolLocal::s_FinalizeCounter.increment( m_local );
 
   // are we a public tool ?
   m_isPublic = isPublic();
 
   // return
   return sc;
 }

bool GaudiTool::isPublic ( ) const

private

Determines if this tool is public or not (i.e. owned by the ToolSvc).

Definition at line 183 of file GaudiTool.cpp.

                                {
   const IAlgTool* tool = this;
   // Recurse down the ownership tree, to see with we ever end up at the ToolSvc
   bool         ownedByToolSvc = false;
   unsigned int sanityCheck( 0 );
   while ( tool && ++sanityCheck < 99999 ) {
     ownedByToolSvc = ( nullptr != dynamic_cast<const IToolSvc*>( tool->parent() ) );
     if ( ownedByToolSvc ) { break; }
     // if parent is also a tool, try again
     tool = dynamic_cast<const IAlgTool*>( tool->parent() );
   }
   return ownedByToolSvc;
 }

INTupleSvc * GaudiTool::ntupleSvc ( ) const

Access the standard N-Tuple.

Returns: pointer to N-Tuple service .

Definition at line 206 of file GaudiTool.cpp.

                                        {
   if ( UNLIKELY( !m_ntupleSvc ) ) m_ntupleSvc = service( "NTupleSvc", true );
   return m_ntupleSvc;
 }

GaudiTool& GaudiTool::operator= ( const GaudiTool & )

privatedelete

void GaudiTool::put	(	IDataProviderSvc *	svc,
		DataObject *	object,
		const std::string &	address,
		const bool	useRootInTES = `true`
	)		const

inline

Register a data object or container into Gaudi Event Transient Store.

MCHits * hits = new MCHits();

put( evtSvc(), hits, "/Event/MC/Hits" );

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

See also: IDataProviderSvc

Parameters

svc	Pointer to data provider service
object	Data object or container to be registered
address	Address in Gaudi Event Transient Store ("/Event" could be omitted )
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Exceptions

GaudiException	for invalid event data service
GaudiException	for invalid object
GaudiException	for error result from event data service

Returns: StatusCode

Return values

StatusCode::SUCCESS	Data was successfully placed in the TES.
StatusCode::FAILURE	Failed to store data in the TES.

Definition at line 188 of file GaudiTool.h.

                                                           {
     put( svc, std::unique_ptr<DataObject>( object ), address, useRootInTES );
   }

void GaudiTool::put	(	IDataProviderSvc *	svc,
		std::unique_ptr< DataObject >	object,
		const std::string &	address,
		const bool	useRootInTES = `true`
	)		const

inline

Definition at line 192 of file GaudiTool.h.

                                                           {
     GaudiCommon<CounterHolder<AlgTool>>::put( svc, std::move( object ), address, useRootInTES );
   }

const DataObject* GaudiTool::put	(	DataObject *	object,
		const std::string &	address,
		const bool	useRootInTES = `true`
	)		const

inline

Register a data object or container into Gaudi Event Transient Store.

See also: IDataProviderSvc

MCHits * hits = put( new MCHits(), "/Event/MC/Hits" );

Attention: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false

Parameters

object	Data object or container to be registered
address	Address in Gaudi Event Transient Store ("/Event" could be omitted )
useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Exceptions

GaudiException	for invalid event data service
GaudiException	for invalid object
GaudiException	for error result from event data service

Returns: StatusCode

Return values

StatusCode::SUCCESS	Data was successfully placed in the TES.
StatusCode::FAILURE	Failed to store data in the TES.

Definition at line 225 of file GaudiTool.h.

                                                                                                                      {
     return put( std::unique_ptr<DataObject>( object ), address, useRootInTES );
   }

const DataObject* GaudiTool::put	(	std::unique_ptr< DataObject >	object,
		const std::string &	address,
		const bool	useRootInTES = `true`
	)		const

inline

Definition at line 228 of file GaudiTool.h.

                                                                        {
     return GaudiCommon<CounterHolder<AlgTool>>::put( evtSvc(), std::move( object ), address, useRootInTES );
   }

bool GaudiTool::summaryEnabled ( )

static

is summary enabled?

Definition at line 125 of file GaudiTool.cpp.

 {
   return s_enableSummary;
 }

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

inline

Print the warning message and return with the given StatusCode.

Also performs statistical analysis of the warning messages and suppression after the defined number of error instances.

if( a < 0 ) { return Warning("a is negative!") ;}
if( b < 0 ) { return Warning("b is illegal!" , StatusCode(25) );
if( c < 0 )
   { return Warning("c is negative" , StatusCode(35) , 50 );

See also: MsgStream; IMessageSvc; StatusCode

Parameters

msg	Warning message
st	StatusCode to return
mx	Maximum number of printouts for this message

Returns: The given StatusCode

Definition at line 690 of file GaudiTool.h.

                                                           {
     return GaudiCommon<CounterHolder<AlgTool>>::Warning( m_isPublic ? msg + getCurrentAlgName() : msg, st, mx );
   }

Member Data Documentation

SmartIF<IChronoStatSvc> GaudiTool::m_chronoSvc

mutableprivate

pointer to Chrono & Stat Service

Definition at line 760 of file GaudiTool.h.

SmartIF<IAlgContextSvc> GaudiTool::m_contextSvc

mutableprivate

Algorithm Context Service.

Definition at line 766 of file GaudiTool.h.

Gaudi::Property<std::string> GaudiTool::m_contextSvcName

private

Initial value:

{this, "ContextService", "AlgContextSvc",

"the name of Algorithm Context Service"}

Definition at line 768 of file GaudiTool.h.

SmartIF<IDataProviderSvc> GaudiTool::m_detSvc

mutableprivate

pointer to Detector Data Service

Definition at line 758 of file GaudiTool.h.

SmartIF<INTupleSvc> GaudiTool::m_evtColSvc

mutableprivate

pointer to the event tag collection service

Definition at line 756 of file GaudiTool.h.

SmartIF<IHistogramSvc> GaudiTool::m_histoSvc

mutableprivate

pointer for histogram service

Definition at line 764 of file GaudiTool.h.

SmartIF<IIncidentSvc> GaudiTool::m_incSvc

mutableprivate

pointer to Incident Service

Definition at line 762 of file GaudiTool.h.

bool GaudiTool::m_isPublic = false

private

Flag to say if the tool is a public or private tool.

Definition at line 774 of file GaudiTool.h.

const std::string GaudiTool::m_local

private

full tool name "type/name"

Definition at line 779 of file GaudiTool.h.

SmartIF<INTupleSvc> GaudiTool::m_ntupleSvc

mutableprivate

pointer to the N-Tuple service

Definition at line 754 of file GaudiTool.h.

bool GaudiTool::s_enableSummary = true

staticprivate

enable printout of summary?

summary is enabled

Definition at line 784 of file GaudiTool.h.

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

GaudiAlg/GaudiAlg/GaudiTool.h
GaudiAlg/src/lib/GaudiTool.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation