The useful base class for data processing algorithms. More...

#include <GaudiAlg/GaudiAlgorithm.h>

Inheritance diagram for GaudiAlgorithm:

[legend]

Collaboration diagram for GaudiAlgorithm:

[legend]

Public Member Functions
StatusCode	initialize () override
	standard initialization method More...

StatusCode	execute () override
	standard execution method More...

StatusCode	finalize () override
	standard finalization method More...

StatusCode	sysExecute (const EventContext &ctx) override
	the generic actions for the execution. 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, std::string_view 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...

	GaudiAlgorithm (std::string name, ISvcLocator *pSvcLocator)
	Standard constructor. More...

	GaudiAlgorithm (const GaudiAlgorithm &)=delete

GaudiAlgorithm &	operator= (const GaudiAlgorithm &)=delete

SmartIF< INTupleSvc > &	evtColSvc () const
	Access the standard event collection service. More...

Public Member Functions inherited from GaudiCommon< Algorithm >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, std::string_view 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, std::string_view 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, std::string_view 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, std::string_view 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, std::string_view location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

DataObject *	put (IDataProviderSvc svc, DataObject object, std::string_view location, const bool useRootInTES=true) const

TOOL *	tool (std::string_view type, std::string_view name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools. More...

TOOL *	tool (std::string_view type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...

SmartIF< SERVICE >	svc (std::string_view 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...

StatusCode	Error (std::string_view 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 (std::string_view 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 (std::string_view msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...

StatusCode	Print (std::string_view 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, std::string_view message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...

void	Exception (std::string_view msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException. More...

void	Exception (std::string_view msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception. More...

void	Exception (std::string_view msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message. More...

StatEntity &	counter (std::string_view tag) const
	accessor to certain counter by name More...

StatEntity &	counter (std::string_view 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 (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 (std::string type, std::string name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...

	GaudiCommon ()=delete

	GaudiCommon (const GaudiCommon &)=delete

StatusCode	initialize () override
	standard initialization method More...

StatusCode	finalize () override
	standard finalization method More...

GaudiCommon &	operator= (const GaudiCommon &)=delete

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...

Public Member Functions inherited from FixTESPath< BASE >
template<typename U = BASE, typename = std::enable_if_t<std::is_base_of_v<Gaudi::Algorithm, BASE>, U>>
	FixTESPath (std::string name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if BASE derives from Algorithm. More...

template<typename U = BASE, typename = std::enable_if_t<std::is_base_of_v<AlgTool, BASE>, U>>
	FixTESPath (std::string type, std::string name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if BASE derives from AlgTool. More...

StatusCode	initialize () override

const std::string &	rootInTES () const
	Returns the "rootInTES" string. More...

std::string	fullTESLocation (std::string_view location, bool useRootInTES) const
	Returns the full correct event location given the rootInTes settings. More...

Private Attributes
SmartIF< INTupleSvc >	m_evtColSvc
	Event Tag Collection Service. More...

Gaudi::Property< std::vector< std::string > >	m_vetoObjs

Gaudi::Property< std::vector< std::string > >	m_requireObjs

Additional Inherited Members
Protected Types inherited from GaudiCommon< Algorithm >
using	base_class = FixTESPath< Algorithm >

typedef std::map< std::string, StatEntity, std::less<> >	StatisticsOwn
	the actual type of general counters More...

typedef std::map< std::string, std::reference_wrapper< Gaudi::Accumulators::PrintableCounter >, std::less<> >	Statistics

typedef std::map< std::string, unsigned int, std::less<> >	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< Algorithm >
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< Algorithm >
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...

Static Protected Attributes inherited from GaudiCommon< Algorithm >
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 data processing algorithms.

Small extension of ordinary the Algorithm 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 shrinkage of existing code lines.

Attention: See also 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: 30/06/2001

Definition at line 104 of file GaudiAlgorithm.h.

Constructor & Destructor Documentation

◆ GaudiAlgorithm() [1/2]

GaudiAlgorithm::GaudiAlgorithm	(	std::string	name,
		ISvcLocator *	pSvcLocator
	)

Standard constructor.

See also: Algorithm

Parameters

name	name of the algorithm
pSvcLocator	pointer to Service Locator

Definition at line 45 of file GaudiAlgorithm.cpp.

     : GaudiCommon<Algorithm>( std::move( name ), pSvcLocator ) {
   setProperty( "RegisterForContextService", true ).ignore();
 }

◆ GaudiAlgorithm() [2/2]

GaudiAlgorithm::GaudiAlgorithm ( const GaudiAlgorithm & )

delete

Member Function Documentation

◆ evtColSvc()

SmartIF< INTupleSvc > & GaudiAlgorithm::evtColSvc ( ) const

Access the standard event collection service.

Returns: pointer to the event collection service

Definition at line 81 of file GaudiAlgorithm.cpp.

                                                      {
   if ( !m_evtColSvc ) { m_evtColSvc = svc<INTupleSvc>( "EvtTupleSvc", true ); }
   //
   return m_evtColSvc;
 }

◆ execute()

StatusCode GaudiAlgorithm::execute ( )

override

standard execution method

See also: Algorithm; IAlgorithm

Returns: status code

Definition at line 77 of file GaudiAlgorithm.cpp.

77 { return Error( "Default GaudiAlgorithm execute method called !!" ); }

GaudiCommon< Algorithm >::Error

StatusCode Error(std::string_view msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const

Print the error message and return with the given StatusCode.

Definition: GaudiCommon.icpp:296

◆ exist() [1/2]

template<class TYPE >

bool GaudiAlgorithm::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 496 of file GaudiAlgorithm.h.

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

◆ exist() [2/2]

template<class TYPE >

bool GaudiAlgorithm::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
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 526 of file GaudiAlgorithm.h.

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

◆ existDet() [1/2]

template<class TYPE >

bool GaudiAlgorithm::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 547 of file GaudiAlgorithm.h.

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

◆ existDet() [2/2]

template<class TYPE >

bool GaudiAlgorithm::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 567 of file GaudiAlgorithm.h.

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

◆ finalize()

StatusCode GaudiAlgorithm::finalize ( )

override

standard finalization method

See also: Algorithm; IAlgorithm

Returns: status code

Definition at line 65 of file GaudiAlgorithm.cpp.

                                     {
   if ( msgLevel( MSG::DEBUG ) ) debug() << "Finalize base class GaudiAlgorithm" << endmsg;
 
   // reset pointers
   m_evtColSvc.reset();
 
   // finalize the base class and return
   return GaudiCommon<Algorithm>::finalize();
 }

◆ get() [1/2]

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::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 256 of file GaudiAlgorithm.h.

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

◆ get() [2/2]

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::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 327 of file GaudiAlgorithm.h.

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

◆ getDet() [1/2]

template<class TYPE >

TYPE* GaudiAlgorithm::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 389 of file GaudiAlgorithm.h.

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

◆ getDet() [2/2]

template<class TYPE >

TYPE* GaudiAlgorithm::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 439 of file GaudiAlgorithm.h.

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

◆ getDetIfExists() [1/2]

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::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 416 of file GaudiAlgorithm.h.

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

◆ getDetIfExists() [2/2]

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::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 465 of file GaudiAlgorithm.h.

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

◆ getIfExists() [1/2]

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::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 295 of file GaudiAlgorithm.h.

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

◆ getIfExists() [2/2]

template<class TYPE >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::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 365 of file GaudiAlgorithm.h.

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

◆ getOrCreate() [1/2]

template<class TYPE , class TYPE2 >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::getOrCreate	(	IDataProviderSvc *	svc,
		std::string_view	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 599 of file GaudiAlgorithm.h.

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

◆ getOrCreate() [2/2]

template<class TYPE , class TYPE2 >

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::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 631 of file GaudiAlgorithm.h.

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

◆ initialize()

StatusCode GaudiAlgorithm::initialize ( )

override

standard initialization method

See also: Algorithm; IAlgorithm

Returns: status code

Definition at line 52 of file GaudiAlgorithm.cpp.

                                       {
   // initialize the base class
   const StatusCode sc = GaudiCommon<Algorithm>::initialize();
   if ( sc.isFailure() ) { return sc; }
 
   // Add any customisations here, that cannot go in GaudiCommon
 
   // return
   return sc;
 }

◆ operator=()

GaudiAlgorithm& GaudiAlgorithm::operator= ( const GaudiAlgorithm & )

delete

◆ put() [1/4]

void GaudiAlgorithm::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 175 of file GaudiAlgorithm.h.

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

◆ put() [2/4]

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

inline

Definition at line 179 of file GaudiAlgorithm.h.

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

◆ put() [3/4]

const DataObject* GaudiAlgorithm::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 = new MCHits();

put( 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

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 215 of file GaudiAlgorithm.h.

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

◆ put() [4/4]

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

inline

Definition at line 218 of file GaudiAlgorithm.h.

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

◆ sysExecute()

StatusCode GaudiAlgorithm::sysExecute ( const EventContext & ctx )

override

the generic actions for the execution.

See also: Algorithm; IAlgorithm; Algorithm::sysExecute

Returns: status code

< guard/sentry

Definition at line 94 of file GaudiAlgorithm.cpp.

                                                                {
   StatusCode sc{StatusCode::SUCCESS};
 
   IAlgContextSvc* algCtx = nullptr;
   if ( registerContext() ) { algCtx = contextSvc(); }
   // Lock the context
   Gaudi::Utils::AlgContext cnt( this, algCtx, ctx ); 
 
   // Do not execute if one or more of the m_vetoObjs exist in TES
   const auto it = find_if( begin( m_vetoObjs ), end( m_vetoObjs ),
                            [&]( const std::string& loc ) { return this->exist<DataObject>( loc ); } );
   if ( it != end( m_vetoObjs ) ) {
     if ( msgLevel( MSG::DEBUG ) ) debug() << *it << " found, skipping event " << endmsg;
     return sc;
   }
 
   // Execute if m_requireObjs is empty
   // or if one or more of the m_requireObjs exist in TES
   bool doIt =
       m_requireObjs.empty() || any_of( begin( m_requireObjs ), end( m_requireObjs ),
                                        [&]( const std::string& loc ) { return this->exist<DataObject>( loc ); } );
 
   // execute the generic method:
   if ( doIt ) sc = Algorithm::sysExecute( ctx );
   return sc;
 }

Member Data Documentation

◆ m_evtColSvc

SmartIF<INTupleSvc> GaudiAlgorithm::m_evtColSvc

mutableprivate

Event Tag Collection Service.

Definition at line 662 of file GaudiAlgorithm.h.

◆ m_requireObjs

Gaudi::Property<std::vector<std::string> > GaudiAlgorithm::m_requireObjs

private

Initial value:

{

this, "RequireObjects", {}, "execute only if one or more of these TES objects exist"}

Definition at line 666 of file GaudiAlgorithm.h.

◆ m_vetoObjs

Gaudi::Property<std::vector<std::string> > GaudiAlgorithm::m_vetoObjs

private

Initial value:

{

this, "VetoObjects", {}, "skip execute if one or more of these TES objects exist"}

Definition at line 664 of file GaudiAlgorithm.h.

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

GaudiAlg/GaudiAlg/GaudiAlgorithm.h
GaudiAlg/src/lib/GaudiAlgorithm.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GaudiAlgorithm() [1/2]

◆ GaudiAlgorithm() [2/2]

Member Function Documentation

◆ evtColSvc()

◆ execute()

◆ exist() [1/2]

◆ exist() [2/2]

◆ existDet() [1/2]

◆ existDet() [2/2]

◆ finalize()

◆ get() [1/2]

◆ get() [2/2]

◆ getDet() [1/2]

◆ getDet() [2/2]

◆ getDetIfExists() [1/2]

◆ getDetIfExists() [2/2]

◆ getIfExists() [1/2]

◆ getIfExists() [2/2]

◆ getOrCreate() [1/2]

◆ getOrCreate() [2/2]

◆ initialize()

◆ operator=()

◆ put() [1/4]

◆ put() [2/4]

◆ put() [3/4]

◆ put() [4/4]

◆ sysExecute()

Member Data Documentation

◆ m_evtColSvc

◆ m_requireObjs

◆ m_vetoObjs