GaudiCommon< PBASE > Class Template Reference

Implements the common functionality between GaudiTools and GaudiAlgorithms. More...

#include <GaudiAlg/GaudiCommon.h>

Inheritance diagram for GaudiCommon< PBASE >:

Collaboration diagram for GaudiCommon< PBASE >:

Public Member Functions
template<class TYPE >
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...
template<class TYPE >
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...
template<class TYPE >
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...
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...
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
template<class TOOL >
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...
template<class TOOL >
TOOL *	tool (std::string_view type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...
template<class SERVICE >
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...
template<class CallerClass >
void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=nullptr)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
template<class CallerClass , class CondType >
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...
template<class CallerClass >
void	registerCondition (char *condition, StatusCode(CallerClass::*mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class. More...
template<class CallerClass , class TargetClass >
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...
template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<Gaudi::Algorithm, PBASE>, U>>
	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...
template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<AlgTool, PBASE>, U>>
	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...
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
	GaudiCommon ()=delete
	GaudiCommon (const GaudiCommon &)=delete
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< PBASE >
	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...
	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...

Protected Types
using	base_class = FixTESPath< PBASE >
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
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
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...

Static Protected Attributes
static const bool	IgnoreRootInTES = false
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...
static const bool	UseRootInTES = true
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

Private Member Functions
StatisticsOwn	countersOwn () const
	accessor to all owned counters More...
void	addToServiceList (SmartIF< IService > svc) const
	Add the given service to the list of acquired services. More...
void	initGaudiCommonConstructor (const IInterface *parent=nullptr)
	Constructor initializations. More...

Static Private Member Functions
static auto	increment (Counter &c, std::string_view which)

Private Attributes
AlgTools	m_managedTools
	List of active tools. More...
Services	m_services
	List of active services. More...
Counter	m_errors
	Counter of errors. More...
Counter	m_warnings
	counter of warnings More...
Counter	m_infos
	counter of infos More...
Counter	m_exceptions
	Counter of exceptions. More...
StatisticsOwn	m_countersOwn
	General counters. More...
std::mutex	m_countersOwnMutex
	The mutex for m_countersOwn. More...
IUpdateManagerSvc *	m_updMgrSvc = nullptr
	Pointer to the Update Manager Service instance. More...
Gaudi::Property< bool >	m_errorsPrint
Gaudi::Property< bool >	m_propsPrint
Gaudi::Property< bool >	m_statPrint
Gaudi::Property< bool >	m_printEmptyCounters
Gaudi::Property< bool >	m_typePrint {this, "TypePrint", true, "add the actual C++ component type into the messages"}
Gaudi::Property< std::string >	m_context {this, "Context", {}, "note: overridden by parent settings"}
Gaudi::Property< std::string >	m_header
Gaudi::Property< std::string >	m_format1
Gaudi::Property< std::string >	m_format2
Gaudi::Property< bool >	m_useEffFormat
Gaudi::Property< std::vector< std::string > >	m_counterList
Gaudi::Property< std::vector< std::string > >	m_statEntityList

Detailed Description

template<class PBASE>
class GaudiCommon< PBASE >

Implements the common functionality between GaudiTools and GaudiAlgorithms.

Author

Chris Jones Chris.nosp@m.toph.nosp@m.er.Ro.nosp@m.b.Jo.nosp@m.nes@c.nosp@m.ern..nosp@m.ch

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

Rob Lambert Rob.L.nosp@m.ambe.nosp@m.rt@ce.nosp@m.rn.c.nosp@m.h

Date

2009-08-04

Definition at line 95 of file GaudiCommon.h.

Member Typedef Documentation

AlgTools

template<class PBASE>

typedef std::vector<IAlgTool*> GaudiCommon< PBASE >::AlgTools

protected

storage for active tools

Definition at line 130 of file GaudiCommon.h.

base_class

template<class PBASE>

using GaudiCommon< PBASE >::base_class = FixTESPath<PBASE>

protected

Definition at line 97 of file GaudiCommon.h.

Counter

template<class PBASE>

typedef std::map<std::string, unsigned int, std::less<> > GaudiCommon< PBASE >::Counter

protected

the actual type error/warning counter

Definition at line 128 of file GaudiCommon.h.

Services

template<class PBASE>

typedef std::vector<SmartIF<IService> > GaudiCommon< PBASE >::Services

protected

storage for active services

Definition at line 132 of file GaudiCommon.h.

Statistics

template<class PBASE>

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

protected

Definition at line 126 of file GaudiCommon.h.

StatisticsOwn

template<class PBASE>

typedef std::map<std::string, StatEntity, std::less<> > GaudiCommon< PBASE >::StatisticsOwn

protected

the actual type of general counters

Definition at line 125 of file GaudiCommon.h.

Constructor & Destructor Documentation

GaudiCommon() [1/4]

template<class PBASE>

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<Gaudi::Algorithm, PBASE>, U>>

GaudiCommon< PBASE >::GaudiCommon ( std::string  name, ISvcLocator *  pSvcLocator  )

inline

Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from Algorithm.

Definition at line 630 of file GaudiCommon.h.

                                                          : base_class( std::move( name ), pSvcLocator ) {
    initGaudiCommonConstructor();
  }

GaudiCommon() [2/4]

template<class PBASE>

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<AlgTool, PBASE>, U>>

GaudiCommon< PBASE >::GaudiCommon ( std::string  type, std::string  name, const IInterface *  ancestor  )

inline

Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool.

Definition at line 636 of file GaudiCommon.h.

      : base_class( std::move( type ), std::move( name ), ancestor ) {
    initGaudiCommonConstructor( this->parent() );
  }

GaudiCommon() [3/4]

template<class PBASE>

GaudiCommon< PBASE >::GaudiCommon ( )

delete

GaudiCommon() [4/4]

template<class PBASE>

GaudiCommon< PBASE >::GaudiCommon ( const GaudiCommon< PBASE > &  )

delete

Member Function Documentation

addToServiceList()

template<class PBASE >

void GaudiCommon< PBASE >::addToServiceList ( SmartIF< IService >  svc ) const

private

Add the given service to the list of acquired services.

Definition at line 276 of file GaudiCommon.icpp.

                                                                       {
  if ( svc ) {
    auto i = std::lower_bound( std::begin( m_services ), std::end( m_services ), svc, GaudiCommon_details::svc_lt );
    if ( i == std::end( m_services ) || !GaudiCommon_details::svc_eq( *i, svc ) ) {
      m_services.insert( i, std::move( svc ) );
    } else {
      this->warning() << "Service " << svc->name() << " already present -- skipping" << endmsg;
    }
  }
}

Assert()

template<class PBASE >

void GaudiCommon< PBASE >::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.

See also

GaudiException

Exceptions

Exception

for invalid condition

Parameters

ok	Condition which should be "true"
message	Message to be associated with the exception

Definition at line 175 of file GaudiCommonImp.h.

                                                                                              {
  if ( !ok ) Exception( msg, sc );
}

context()

template<class PBASE>

const std::string& GaudiCommon< PBASE >::context ( ) const

inline

Returns the "context" string. Used to identify different processing states.

Definition at line 694 of file GaudiCommon.h.

{ return m_context; }

counter() [1/2]

template<class PBASE>

StatEntity& GaudiCommon< PBASE >::counter ( std::string_view  tag ) const

inline

accessor to certain counter by name

if ( OK ) { ++counter("OK") ; }

// additive counter ('Flag')
counter("#Tracks") += tracks->size() ;

// multiplicative counter  ('Weight')
counter("ProbTot") *= probability ;

See also

StatEntuty

Parameters

tag	counter name

Returns

the counter itself

Definition at line 495 of file GaudiCommon.h.

{ return const_cast<GaudiCommon<PBASE>*>( this )->counter( tag ); }

counter() [2/2]

template<class PBASE>

StatEntity& GaudiCommon< PBASE >::counter ( std::string_view  tag )

inline

Definition at line 496 of file GaudiCommon.h.

                                            {
    auto lock = std::scoped_lock{m_countersOwnMutex};
    // Return referenced StatEntity if it already exists, else create it
    auto p = m_countersOwn.find( tag );
    if ( UNLIKELY( p == m_countersOwn.end() ) ) {
      auto [iter, b] = m_countersOwn.try_emplace( std::string{tag} );
      assert( b );
      this->declareCounter( iter->first, iter->second );
      p = iter;
    }
    return p->second;
  }

countersOwn()

template<class PBASE>

StatisticsOwn GaudiCommon< PBASE >::countersOwn ( ) const

inlineprivate

accessor to all owned counters

Definition at line 473 of file GaudiCommon.h.

{ return m_countersOwn; }

Error()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::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.

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 296 of file GaudiCommon.icpp.

                                                                                                     {
  // increase local counter of errors
  const size_t num = increment( m_errors, msg );
  // If suppressed, just return
  if ( num > mx ) {
    return st;
  } else if ( UNLIKELY( num == mx ) ) // issue one-time suppression message
  {
    return Print( std::string{"The   ERROR message is suppressed : '"}.append( msg ).append( "'" ), st, MSG::ERROR );
  }
  // return message
  return Print( msg, st, MSG::ERROR );
}

errorsPrint()

template<class PBASE>

bool GaudiCommon< PBASE >::errorsPrint ( ) const

inline

Print error counters at finalization ?

Definition at line 517 of file GaudiCommon.h.

{ return m_errorsPrint; }

Exception() [1/3]

template<class PBASE >

void GaudiCommon< PBASE >::Exception	(	std::string_view	msg,
		const GaudiException &	exc,
		const StatusCode	sc = StatusCode( StatusCode::FAILURE, true )
	)		const

Create and (re)-throw a given GaudiException.

See also

GaudiException

Exceptions

GaudiException

always thrown!

Parameters

msg	Exception message
exc	(previous) exception of type GaudiException

Definition at line 384 of file GaudiCommon.icpp.

                                                                                                             {
  // increase local counter of exceptions
  increment( m_exceptions, msg );
  Print( std::string{"Exception (re)throw: "}.append( msg ), sc, MSG::FATAL ).ignore();
  throw GaudiException( ( this->name() + ":: " ).append( msg ), this->name(), sc, exc );
}

Exception() [2/3]

template<class PBASE >

void GaudiCommon< PBASE >::Exception	(	std::string_view	msg,
		const std::exception &	exc,
		const StatusCode	sc = StatusCode( StatusCode::FAILURE, true )
	)		const

Create and (re)-throw a given exception.

See also

GaudiException

Exceptions

std::exception

always thrown!

Parameters

msg	Exception message
exc	(previous) exception of type std::exception
sc	StatusCode

Definition at line 396 of file GaudiCommon.icpp.

                                                                                                           {
  // increase local counter of exceptions
  increment( m_exceptions, msg );
  Print( std::string{"Exception (re)throw: "}.append( msg ), sc, MSG::FATAL ).ignore();
  throw GaudiException( ( this->name() + ":: " ).append( msg ) + "(" + exc.what() + ")", "", sc );
}

Exception() [3/3]

template<class PBASE >

void GaudiCommon< PBASE >::Exception	(	std::string_view	msg = "no message",
		const StatusCode	sc = StatusCode( StatusCode::FAILURE, true )
	)		const

Create and throw an exception with the given message.

See also

GaudiException

Exceptions

GaudiException

always thrown!

Parameters

msg	Exception message
sc	StatusCode

Definition at line 408 of file GaudiCommon.icpp.

                                                                                  {
  // increase local counter of exceptions
  increment( m_exceptions, msg );
  Print( std::string{"Exception throw: "}.append( msg ), sc, MSG::FATAL ).ignore();
  throw GaudiException( ( this->name() + ":: " ).append( msg ), "", sc );
}

exist()

template<class PBASE >

template<class TYPE >

bool GaudiCommon< PBASE >::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.

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 provider service
location	Address in Gaudi Transient 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 61 of file GaudiCommonImp.h.

                                                                                                                  {
  // check the environment
  Assert( service, "exist():: IDataProvider* points to NULL!" );
  // check the data object
  Gaudi::Utils::CheckData<TYPE> checker;
  return checker( service, this->fullTESLocation( location, useRootInTES ) );
}

finalize()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::finalize ( )

override

standard finalization method

Returns

status code

Definition at line 141 of file GaudiCommon.icpp.

                                        {
  StatusCode sc = StatusCode::SUCCESS;

  // print the general information about statistical counters
  if ( this->msgLevel( MSG::DEBUG ) || ( statPrint() && this->nCounters() > 0 ) ) {
    // print general statistical counters
    printStat( statPrint() ? MSG::ALWAYS : MSG::DEBUG );
  }
  // add all counters to the CounterSummarySvc
  if ( m_counterSummarySvc && this->svcLoc()->existsService( "CounterSummarySvc" ) ) {
    if ( this->msgLevel( MSG::DEBUG ) ) this->debug() << "adding counters to CounterSummarySvc" << endmsg;

    Gaudi::Utils::RegEx::matchList statList{m_statEntityList.value()};
    Gaudi::Utils::RegEx::matchList counterList{m_counterList.value()};

    for ( const auto& i : m_countersOwn ) {
      if ( statList.Or( i.first ) )
        m_counterSummarySvc->addCounter( this->name(), i.first, i.second, Gaudi::CounterSummary::SaveStatEntity );
      else if ( counterList.Or( i.first ) )
        m_counterSummarySvc->addCounter( this->name(), i.first, i.second );
    }
  }
  // release all located tools and services
  if ( this->msgLevel( MSG::DEBUG ) ) {
    this->debug() << "Tools to release :";
    for ( const auto& i : m_managedTools ) { this->debug() << " " << i->name(); }
    this->debug() << endmsg;
  }
  while ( !m_managedTools.empty() ) {
    sc = ( releaseTool( m_managedTools.back() ) && sc ) ? StatusCode::SUCCESS : StatusCode::FAILURE;
  }

  // release all located services
  if ( this->msgLevel( MSG::DEBUG ) ) {
    this->debug() << "Services to release :";
    for ( const auto& i : m_services ) this->debug() << " " << i->name();
    this->debug() << endmsg;
  }
  while ( !m_services.empty() ) {
    sc = ( releaseSvc( m_services.front() ) && sc ) ? StatusCode::SUCCESS : StatusCode::FAILURE;
  }

  // release the CounterSummarySvc manually
  m_counterSummarySvc.reset();

  // format printout
  if ( !m_errors.empty() || !m_warnings.empty() || !m_exceptions.empty() ) {
    this->always() << "Exceptions/Errors/Warnings/Infos Statistics : " << m_exceptions.size() << "/" << m_errors.size()
                   << "/" << m_warnings.size() << "/" << m_infos.size() << endmsg;
    if ( errorsPrint() ) { printErrors(); }
  }

  // clear *ALL* counters explicitly
  this->clearCounters();
  m_countersOwn.clear(); // then delete any owned counters
  m_exceptions.clear();
  m_infos.clear();
  m_warnings.clear();
  m_errors.clear();
  m_counterList.clear();
  m_statEntityList.clear();

  // finalize base class
  return ( sc && base_class::finalize() ? StatusCode::SUCCESS : StatusCode::FAILURE );
}

get()

template<class PBASE >

template<class TYPE >

Gaudi::Utils::GetData< TYPE >::return_type GaudiCommon< PBASE >::get	(	IDataProviderSvc *	svc,
		std::string_view	location,
		const bool	useRootInTES = true
	)		const

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

// Will access MCHits from the given location
MCHits* hits = get<MCHits>( evtSvc () , "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 36 of file GaudiCommonImp.h.

                                                                                                           {
  // check the environment
  Assert( service, "get():: IDataProvider* points to NULL!" );
  // get the helper object:
  Gaudi::Utils::GetData<TYPE> getter;
  return getter( *this, service, this->fullTESLocation( location, useRootInTES ) );
}

getIfExists()

template<class PBASE >

template<class TYPE >

Gaudi::Utils::GetData< TYPE >::return_type GaudiCommon< PBASE >::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.

Definition at line 49 of file GaudiCommonImp.h.

                                                                                                                   {
  // check the environment
  Assert( service, "get():: IDataProvider* points to NULL!" );
  // get the helper object:
  Gaudi::Utils::GetData<TYPE> getter;
  return getter( *this, service, this->fullTESLocation( location, useRootInTES ), false );
}

getOrCreate()

template<class PBASE >

template<class TYPE , class TYPE2 >

Gaudi::Utils::GetData< TYPE >::return_type GaudiCommon< PBASE >::getOrCreate	(	IDataProviderSvc *	svc,
		std::string_view	location,
		const bool	useRootInTES = true
	)		const

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 provider service
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 data object

Definition at line 76 of file GaudiCommonImp.h.

                                                                                                                   {
  // check the environment
  Assert( service, "getOrCreate():: svc points to NULL!" );
  // get the helper object
  Gaudi::Utils::GetOrCreateData<TYPE, TYPE2> getter;
  return getter( *this, service, this->fullTESLocation( location, useRootInTES ), location );
}

increment()

template<class PBASE>

static auto GaudiCommon< PBASE >::increment ( Counter &  c, std::string_view  which  )

inlinestaticprivate

Definition at line 709 of file GaudiCommon.h.

                                                            {
    auto i = c.find( which );
    return i != c.end() ? ++( i->second ) : c.emplace( which, 1 ).first->second;
  }

Info()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::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.

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 334 of file GaudiCommon.icpp.

                                                                                                    {
  // increase local counter of warnings
  const size_t num = increment( m_infos, msg );
  // If suppressed, just return
  if ( num > mx ) {
    return st;
  } else if ( UNLIKELY( num == mx ) ) // issue one-time suppression message
  {
    return Print( std::string{"The INFO message is suppressed : '"}.append( msg ).append( "'" ), st, MSG::INFO );
  }
  // return message
  return Print( msg, st, MSG::INFO );
}

initGaudiCommonConstructor()

template<class PBASE >

void GaudiCommon< PBASE >::initGaudiCommonConstructor ( const IInterface *  parent = nullptr )

private

Constructor initializations.

Definition at line 75 of file GaudiCommon.icpp.

                                                                              {
  // setup context from parent if available
  if ( parent ) {
    if ( const GaudiAlgorithm* gAlg = dynamic_cast<const GaudiAlgorithm*>( parent ) ) {
      m_context = gAlg->context();
    } else if ( const GaudiTool* gTool = dynamic_cast<const GaudiTool*>( parent ) ) {
      m_context = gTool->context();
    }
  }

  // Get the job option service
  auto jos = PBASE::template service<IJobOptionsSvc>( "JobOptionsSvc" );
  if ( !jos ) Exception( "Cannot get JobOptionsSvc" );

  // Get the "Context" option if in the file...
  const auto myList = jos->getProperties( this->name() );
  if ( myList ) {
    // Iterate over the list to set the options
    for ( const auto& iter : *myList ) {
      const Gaudi::Property<std::string>* sp = dynamic_cast<const Gaudi::Property<std::string>*>( iter );
      if ( sp && iter->name().compare( "Context" ) == 0 ) { m_context = sp->value(); }
    }
  }
}

initialize()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::initialize ( )

override

standard initialization method

Returns

status code

Definition at line 105 of file GaudiCommon.icpp.

                                          {

  // initialize base class
  const StatusCode sc = base_class::initialize();
  if ( sc.isFailure() ) { return Error( "Failed to initialise base class PBASE", sc ); }

  // some debug printout
  if ( this->msgLevel( MSG::DEBUG ) ) {
    this->debug() << "Initialize base class GaudiCommon<" << System::typeinfoName( typeid( PBASE ) ) << ">" << endmsg;
    if ( !context().empty() ) this->debug() << "Created with context = '" << context() << "'" << endmsg;
  }

  // Set up the CounterSummarySvc May need to be changed
  m_counterSummarySvc = this->svcLoc()->service( "CounterSummarySvc", false );
  if ( this->msgLevel( MSG::DEBUG ) ) {
    if ( !m_counterSummarySvc )
      this->debug() << "could not locate CounterSummarySvc, no counter summary will be made" << endmsg;
    else
      this->debug() << "found CounterSummarySvc OK" << endmsg;
  }

  // properties will be printed if asked for or in "MSG::DEBUG" mode
  if ( propsPrint() ) {
    printProps( MSG::ALWAYS );
  } else if ( this->msgLevel( MSG::DEBUG ) ) {
    printProps( MSG::DEBUG );
  }

  return sc;
}

operator=()

template<class PBASE>

GaudiCommon& GaudiCommon< PBASE >::operator= ( const GaudiCommon< PBASE > &  )

delete

Print()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::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.

See also

MsgStream

IMessageSvc

StatusCode

Parameters

msg	Message to print
st	StatusCode to return
lev	Printout level for the given message

Returns

The given StatusCode

Definition at line 353 of file GaudiCommon.icpp.

                                                                                                        {
  // perform printout ?
  if ( !this->msgLevel( lvl ) ) { return st; } // RETURN

  // use the predefined stream
  MsgStream& str = this->msgStream( lvl );
  if ( typePrint() ) { str << System::typeinfoName( typeid( *this ) ) << ":: "; }

  // print the message
  str << msg;

  // test status code
  if ( st.isSuccess() ) {
  } else if ( StatusCode::FAILURE != st ) {
    str << " StatusCode=" << st.getCode();
  } else {
    str << " StatusCode=FAILURE";
  }

  // perform print operation
  str << endmsg;

  // return
  return st;
}

printErrors()

template<class PBASE >

long GaudiCommon< PBASE >::printErrors

(

const MSG::Level

level = MSG::ALWAYS

)

const

perform the actual printout of error counters

Parameters

level

The message level to print at

Returns

number of error counters

Definition at line 452 of file GaudiCommon.icpp.

                                                                 {
  // format for printout
  boost::format ftm( " #%|-10s| = %|.8s| %|23t| Message = '%s'" );

  auto print = [&]( const Counter& c, const auto& label ) {
    for ( const auto& i : c ) { this->msgStream( level ) << ( ftm % label % i.second % i.first ) << endmsg; }
  };

  print( m_exceptions, "EXCEPTIONS" );
  print( m_errors, "ERRORS" );
  print( m_warnings, "WARNINGS" );
  print( m_infos, "INFOS" );

  // return total number of errors+warnings+exceptions
  return m_exceptions.size() + m_errors.size() + m_warnings.size() + m_infos.size();
}

printProps()

template<class PBASE >

long GaudiCommon< PBASE >::printProps

(

const MSG::Level

level = MSG::ALWAYS

)

const

perform the actual printout of properties

perform the printout of properties

Parameters

level

The message level to print at

Returns

number of properties

number of error counters

Definition at line 476 of file GaudiCommon.icpp.

                                                                {

  // print ALL properties
  MsgStream&  msg        = this->msgStream( level );
  const auto& properties = this->getProperties();
  msg << "List of ALL properties of " << System::typeinfoName( typeid( *this ) ) << "/" << this->name()
      << "  #properties = " << properties.size() << endmsg;
  for ( const auto& property : reverse( properties ) ) { msg << "Property ['Name': Value] = " << *property << endmsg; }
  return properties.size();
}

printStat()

template<class PBASE >

long GaudiCommon< PBASE >::printStat

(

const MSG::Level

level = MSG::ALWAYS

)

const

perform the actual printout of statistical counters

Parameters

level

The message level to print at

Returns

number of active statistical counters

Definition at line 420 of file GaudiCommon.icpp.

                                                               {
  // check how many counters think they should be printed or how many
  // we anyway want to print
  auto countToBePrinted = [&]() {
    unsigned n = 0;
    this->forEachCounter( [&n]( const auto&, const auto& counter ) { n += counter.toBePrinted(); } );
    return n;
  };
  auto nbPrintedCounters =
      ( ( !m_printEmptyCounters && !this->msgLevel( MSG::DEBUG ) ) ? countToBePrinted() : this->nCounters() );
  // in case nothing should be printed, let's stop here
  if ( nbPrintedCounters == 0 ) return 0;
  MsgStream& msg = this->msgStream( level );
  msg << "Number of counters : " << nbPrintedCounters << "\n" << m_header.value();
  this->forEachCounter( [&]( const auto& label, const auto& counter ) {
    if ( m_printEmptyCounters || this->msgLevel( MSG::DEBUG ) || counter.toBePrinted() ) {
      std::ostringstream ost;
      counter.print( ost, label );
      msg << "\n" << ost.str();
    }
  } );
  //
  msg << endmsg;
  //
  return nbPrintedCounters;
}

propsPrint()

template<class PBASE>

bool GaudiCommon< PBASE >::propsPrint ( ) const

inline

Print properties at initialization ?

Definition at line 513 of file GaudiCommon.h.

{ return m_propsPrint; }

put() [1/2]

template<class PBASE >

DataObject * GaudiCommon< PBASE >::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.

See also

IDataProviderSvc

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 provider service
object	Data object or container to be registered
location	Location 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 496 of file GaudiCommon.icpp.

                                                                                              {
  // check arguments
  Assert( svc, "put():: Invalid 'service'!" );
  Assert( static_cast<bool>( object ), "put():: Invalid 'Object'!" );
  Assert( !location.empty(), "put():: Invalid 'address' = '' " );
  // final data location
  const auto& fullLocation = this->fullTESLocation( location, useRootInTES );
  // register the object!
  const StatusCode status = '/' == fullLocation[0] ? svc->registerObject( fullLocation, object.get() )
                                                   : svc->registerObject( "/Event/" + fullLocation, object.get() );
  // check the result!
  DataObject& obj = *object;
  if ( status.isFailure() ) {
    Exception( "put():: could not register '" + System::typeinfoName( typeid( obj ) ) + "' at address '" +
                   fullLocation + "'",
               status );
  }
  if ( this->msgLevel( MSG::DEBUG ) ) {
    Print( "The object of type '" + System::typeinfoName( typeid( obj ) ) + "' is registered in TS at address '" +
               fullLocation + "'",
           status, MSG::DEBUG )
        .ignore();
  }
  // if we get here, ownership has been transferred to the IDataProviderSvc
  return object.release();
}

put() [2/2]

template<class PBASE>

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

inline

Definition at line 269 of file GaudiCommon.h.

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

registerCondition() [1/4]

template<class PBASE>

template<class CallerClass >

void GaudiCommon< PBASE >::registerCondition ( const std::string &  condition, StatusCode(CallerClass::*)()  mf = nullptr  )

inline

register the current instance to the UpdateManagerSvc as a consumer for a condition.

Parameters

condition	the path inside the Transient Detector Store to the condition object.
mf	optional pointer to the member function to call when the condition object is updated. If the pointer is omitted the user must explicitly provide the class name to the method. StatusCode MyAlg::initialize(){ // ... registerCondition("/dd/Conditions/Readout/MyDet/MyCond",&MyAlg::i_CallBack); registerCondition<MyAlg>("/dd/Conditions/Readout/MyDet/MyOtherCond"); // ... return StatusCode.SUCCESS; }

Definition at line 551 of file GaudiCommon.h.

                                                                                                  {
    updMgrSvc()->registerCondition( dynamic_cast<CallerClass*>( this ), condition, mf );
  }

registerCondition() [2/4]

template<class PBASE>

template<class CallerClass , class CondType >

void GaudiCommon< PBASE >::registerCondition ( const std::string &  condition, CondType *&  condPtrDest, StatusCode(CallerClass::*)()  mf = NULL  )

inline

register the current instance to the UpdateManagerSvc as a consumer for a condition.

This version of the method allow the user to specify where to put a copy of the pointer to the condition object.

Parameters

condition	the path inside the Transient Detector Store to the condition object.
condPtrDest	pointer to fill with the location of the condition object. Note: the pointer can be safely used only in the execute method or in the member function triggered by the update.
mf	optional pointer to the member function to call when the condition object is updated. If the pointer is omitted the user must explicitly provide the class name to the method. class MyAlg: public GaudiAlgorithm { // ... public: virtual StatusCode i_CallBack(); private: Condition *m_MyCond; SpecialCondition *m_MyOtherCond; // ... }; StatusCode MyAlg::initialize(){ // ... registerCondition("/dd/Conditions/Readout/MyDet/MyCond",m_MyCond,&MyAlg::i_CallBack); registerCondition<MyAlg>("/dd/Conditions/Readout/MyDet/MyOtherCond",m_MyOtherCond); // ... return StatusCode.SUCCESS; }

Definition at line 585 of file GaudiCommon.h.

                                                                   {
    updMgrSvc()->registerCondition( dynamic_cast<CallerClass*>( this ), condition, mf, condPtrDest );
  }

registerCondition() [3/4]

template<class PBASE>

template<class CallerClass >

void GaudiCommon< PBASE >::registerCondition ( char *  condition, StatusCode(CallerClass::*)()  mf = NULL  )

inline

just to avoid conflicts with the version using a pointer to a template class.

Definition at line 591 of file GaudiCommon.h.

                                                                                    {
    updMgrSvc()->registerCondition( dynamic_cast<CallerClass*>( this ), std::string( condition ), mf );
  }

registerCondition() [4/4]

template<class PBASE>

template<class CallerClass , class TargetClass >

void GaudiCommon< PBASE >::registerCondition ( TargetClass *  condition, StatusCode(CallerClass::*)()  mf = NULL  )

inline

register the current instance to the UpdateManagerSvc as a consumer for a condition.

Parameters

condition	the path inside the Transient Detector Store to the condition object.
mf	optional pointer to the member function to call when the condition object is updated. If the pointer is omitted the user must explicitly provide the class name to the method. StatusCode MyAlg::initialize(){ // ... registerCondition("/dd/Conditions/Readout/MyDet/MyCond",&MyAlg::i_CallBack); registerCondition<MyAlg>("/dd/Conditions/Readout/MyDet/MyOtherCond"); // ... return StatusCode.SUCCESS; }

Definition at line 610 of file GaudiCommon.h.

                                                                                           {
    updMgrSvc()->registerCondition( dynamic_cast<CallerClass*>( this ), condition, mf );
  }

release()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::release

(

const IInterface *

interface

)

const

Manual forced (and 'safe') release of the active tool or service.

IMyTool* mytool = tool<IMyTool>( .... ) ;
mytool->spendCPUtime() ;
release ( mytool ) ;

IMySvc* msvc = svc<IMySvc>( .... ) ;
msvc->spendCPUtime() ;
release ( msvc ) ;

Parameters

interface

Interface pointer to the interface to be released

Returns

StatusCode

Return values

StatusCode::SUCCESS	Tool or service was successfully released
StatusCode::FAILURE	Error releasing too or service

Definition at line 216 of file GaudiCommon.icpp.

                                                                          {
  if ( !interface ) { return Error( "release(IInterface):: IInterface* points to NULL!" ); }
  // dispatch between tools and services
  const IAlgTool* algTool = dynamic_cast<const IAlgTool*>( interface );
  // perform the actual release
  return algTool ? releaseTool( algTool ) : releaseSvc( interface );
}

releaseSvc()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::releaseSvc ( const IInterface *  svc ) const

protected

manual forced (and 'safe') release of the service

Definition at line 257 of file GaudiCommon.icpp.

                                                                       {
  if ( !Svc ) return Error( "releaseSvc(IInterface):: IInterface* points to NULL!" );
  SmartIF<IService> svc{const_cast<IInterface*>( Svc )};
  if ( !svc ) return Warning( "releaseSvc(IInterface):: IInterface* is not a service" );
  auto it = std::lower_bound( std::begin( m_services ), std::end( m_services ), svc, GaudiCommon_details::svc_lt );
  if ( it == m_services.end() || !GaudiCommon_details::svc_eq( *it, svc ) ) {
    return Warning( "releaseSvc(IInterface):: IInterface* is not active" );
  }
  if ( this->msgLevel( MSG::DEBUG ) ) { this->debug() << "Releasing service '" << ( *it )->name() << "'" << endmsg; }
  m_services.erase( it );
  return StatusCode::SUCCESS;
}

releaseTool()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::releaseTool ( const IAlgTool *  tool ) const

protected

manual forced (and 'safe') release of the tool

Definition at line 229 of file GaudiCommon.icpp.

                                                                          {
  if ( !algTool ) { return Error( "releaseTool(IAlgTool):: IAlgTool* points to NULL!" ); }
  if ( !this->toolSvc() ) { return Error( "releaseTool(IAlgTool):: IToolSvc* points to NULL!" ); }
  // find a tool in the list of active tools
  auto it = std::find( m_managedTools.begin(), m_managedTools.end(), algTool );
  if ( m_managedTools.end() == it ) { return Warning( "releaseTool(IAlgTool):: IAlgTool* is not active" ); }
  // get the tool
  IAlgTool* t = *it;
  // cache name
  const std::string name = t->name();
  if ( this->msgLevel( MSG::DEBUG ) ) { this->debug() << "Releasing tool '" << name << "'" << endmsg; }
  // remove the tool from the lists
  base_class::deregisterTool( t );
  m_managedTools.erase( it );
  // release tool
  if ( this->msgLevel( MSG::DEBUG ) ) {
    this->debug() << "The tool '" << t->name() << "' of type '" << System::typeinfoName( typeid( *t ) )
                  << "' is released" << endmsg;
  }
  const StatusCode sc = this->toolSvc()->releaseTool( t );
  return sc.isSuccess() ? sc : Warning( "releaseTool(IAlgTool):: error from IToolSvc releasing " + name, sc );
}

runUpdate()

template<class PBASE>

StatusCode GaudiCommon< PBASE >::runUpdate ( )

inline

asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident.

It is useful if the instance can be instantiated after a BeginEvent incident, and used before the next one (for example with tools).

StatusCode MyTool::initialize(){
  // ...
  return runUpdate();
}

Definition at line 624 of file GaudiCommon.h.

{ return updMgrSvc()->update( this ); }

services()

template<class PBASE>

const Services& GaudiCommon< PBASE >::services ( ) const

inline

get the list of aquired services

Definition at line 689 of file GaudiCommon.h.

{ return m_services; } // get all services

statPrint()

template<class PBASE>

bool GaudiCommon< PBASE >::statPrint ( ) const

inline

Print statistical counters at finalization ?

Definition at line 515 of file GaudiCommon.h.

{ return m_statPrint; }

svc()

template<class PBASE >

template<class SERVICE >

SmartIF< SERVICE > GaudiCommon< PBASE >::svc	(	std::string_view	name,
		const bool	create = true
	)		const

A useful method for the easy location of services.

IMyService* mySvc = svc<IMyService>( "MyServiceType" );

Attention

The services located with this method will be released automatically

See also

IService

ISevcLocator

Service

Exceptions

GaudiException	for error in Algorithms::service
GaudiException	for invalid service

Parameters

name	service type name
create	Flag for creation of non-existing services

Returns

A pointer to the service

Definition at line 137 of file GaudiCommonImp.h.

                                                                                       {
  Assert( this->svcLoc(), "ISvcLocator* points to NULL!" );
  SmartIF<SERVICE> s;
  // check if we already have this service
  auto it = std::lower_bound( std::begin( m_services ), std::end( m_services ), name, GaudiCommon_details::svc_lt );
  if ( it != std::end( m_services ) && GaudiCommon_details::svc_eq( *it, name ) ) {
    // Try to get the requested interface
    s = *it;
    // check the results
    if ( !s ) {
      Exception( std::string{"svc():: Could not retrieve Svc '"}.append( name ).append( "'" ), StatusCode::FAILURE );
    }
  } else {
    auto baseSvc = this->svcLoc()->service( name, create );
    // Try to get the requested interface
    s = baseSvc;
    // check the results
    if ( !baseSvc || !s ) {
      Exception( std::string{"svc():: Could not retrieve Svc '"}.append( name ).append( "'" ), StatusCode::FAILURE );
    }
    // add the tool into list of known tools, to be properly released
    addToServiceList( baseSvc );
  }
  // return *VALID* located service
  return s;
}

tool() [1/2]

template<class PBASE >

template<class TOOL >

TOOL * GaudiCommon< PBASE >::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.

IMyTool* myTool =
    tool<IMyTool>( "MyToolType", "MyToolName", this );

Attention

The tools located with this method will be released automatically

See also

IToolSvc

IAlgTool

Exceptions

GaudiException	for invalid Tool Service
GaudiException	for error from Tool Service
GaudiException	for invalid tool

Parameters

type	Tool type
name	Tool name
parent	Tool parent
create	Flag for creation of nonexisting tools

Returns

A pointer to the tool

Definition at line 88 of file GaudiCommonImp.h.

                                                    {
  // for empty names delegate to another method
  if ( name.empty() ) return tool<TOOL>( type, parent, create );
  Assert( this->toolSvc(), "tool():: IToolSvc* points to NULL!" );
  // get the tool from Tool Service
  TOOL*            Tool = nullptr;
  const StatusCode sc   = this->toolSvc()->retrieveTool( type, name, Tool, parent, create );
  if ( sc.isFailure() ) {
    Exception(
        std::string{"tool():: Could not retrieve Tool '"}.append( type ).append( "'/'" ).append( name ).append( "'" ),
        sc );
  }
  if ( !Tool ) {
    Exception(
        std::string{"tool():: Could not retrieve Tool '"}.append( type ).append( "'/'" ).append( name ).append( "'" ) );
  }
  // insert tool into list of tools
  PBASE::registerTool( Tool );
  m_managedTools.push_back( Tool );
  // return *VALID* located tool
  return Tool;
}

tool() [2/2]

template<class PBASE >

template<class TOOL >

TOOL * GaudiCommon< PBASE >::tool	(	std::string_view	type,
		const IInterface *	parent = 0,
		bool	create = true
	)		const

A useful method for the easy location of tools.

IMyTool* myTool = tool<IMyTool>( "PublicToolType" );

Attention

The tools located with this method will be released automatically

See also

IToolSvc

IAlgTool

Exceptions

GaudiException	for invalid Tool Service
GaudiException	for error from Tool Service
GaudiException	for invalid tool

Parameters

type	Tool type, could be of "Type/Name" format
parent	Tool parent
create	Flag for creation of non-existing tools

Returns

A pointer to the tool

Definition at line 116 of file GaudiCommonImp.h.

                                                                                                 {
  // check the environment
  Assert( PBASE::toolSvc(), "IToolSvc* points to NULL!" );
  // retrieve the tool from Tool Service
  TOOL*            Tool = nullptr;
  const StatusCode sc   = this->toolSvc()->retrieveTool( type, Tool, parent, create );
  if ( sc.isFailure() ) {
    Exception( std::string{"tool():: Could not retrieve Tool '"}.append( type ).append( "'" ), sc );
  }
  if ( !Tool ) { Exception( std::string{"tool():: Could not retrieve Tool '"}.append( type ).append( "'" ) ); }
  // add the tool into the list of known tools to be properly released
  PBASE::registerTool( Tool );
  m_managedTools.push_back( Tool );
  // return *VALID* located tool
  return Tool;
}

typePrint()

template<class PBASE>

bool GaudiCommon< PBASE >::typePrint ( ) const

inline

Insert the actual C++ type of the algorithm/tool in the messages ?

Definition at line 511 of file GaudiCommon.h.

{ return m_typePrint; }

updMgrSvc()

template<class PBASE >

IUpdateManagerSvc * GaudiCommon< PBASE >::updMgrSvc

(

)

const

Short-cut to locate the Update Manager Service.

Definition at line 167 of file GaudiCommonImp.h.

                                                       {
  if ( !m_updMgrSvc ) { m_updMgrSvc = svc<IUpdateManagerSvc>( "UpdateManagerSvc", true ); }
  return m_updMgrSvc;
}

Warning()

template<class PBASE >

StatusCode GaudiCommon< PBASE >::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.

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 315 of file GaudiCommon.icpp.

                                                                                                       {
  // increase local counter of warnings
  const size_t num = increment( m_warnings, msg );
  // If suppressed, just return
  if ( num > mx ) {
    return st;
  } else if ( UNLIKELY( num == mx ) ) // issue one-time suppression message
  {
    return Print( std::string{"The WARNING message is suppressed : '"}.append( msg ).append( "'" ), st, MSG::WARNING );
  }
  // return message
  return Print( msg, st, MSG::WARNING );
}

Member Data Documentation

IgnoreRootInTES

template<class PBASE>

const bool GaudiCommon< PBASE >::IgnoreRootInTES = false

staticprotected

Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.

If used with cause the RootInTES option to be IGNORED.

Useful to aid with code readability. e.g.

// Get data, ignoring the setting of rootInTES()
MyData * data = get<MyData>( "/Event/MyData", IgnoreRootInTES );

Definition at line 108 of file GaudiCommon.h.

m_context

template<class PBASE>

Gaudi::Property<std::string> GaudiCommon< PBASE >::m_context {this, "Context", {}, "note: overridden by parent settings"}

private

Definition at line 760 of file GaudiCommon.h.

m_counterList

template<class PBASE>

Gaudi::Property<std::vector<std::string> > GaudiCommon< PBASE >::m_counterList

private

Initial value:

{
      this, "CounterList", {".*"}, "RegEx list, of simple integer counters for CounterSummary"}

Definition at line 775 of file GaudiCommon.h.

m_countersOwn

template<class PBASE>

StatisticsOwn GaudiCommon< PBASE >::m_countersOwn

private

General counters.

Definition at line 722 of file GaudiCommon.h.

m_countersOwnMutex

template<class PBASE>

std::mutex GaudiCommon< PBASE >::m_countersOwnMutex

private

The mutex for m_countersOwn.

Definition at line 724 of file GaudiCommon.h.

m_counterSummarySvc

template<class PBASE>

SmartIF<ICounterSummarySvc> GaudiCommon< PBASE >::m_counterSummarySvc

protected

a pointer to the CounterSummarySvc

Definition at line 137 of file GaudiCommon.h.

m_errors

template<class PBASE>

Counter GaudiCommon< PBASE >::m_errors

mutableprivate

Counter of errors.

Definition at line 714 of file GaudiCommon.h.

m_errorsPrint

template<class PBASE>

Gaudi::Property<bool> GaudiCommon< PBASE >::m_errorsPrint

private

Initial value:

{this, "ErrorsPrint", true,
                                      [this]( auto& ) {
                                        
                                        if ( this->FSMState() >= Gaudi::StateMachine::INITIALIZED &&
                                             this->errorsPrint() ) {
                                          this->printErrors();
                                        }
                                      },
                                      "print the statistics of errors/warnings/exceptions"}

Definition at line 730 of file GaudiCommon.h.

m_exceptions

template<class PBASE>

Counter GaudiCommon< PBASE >::m_exceptions

mutableprivate

Counter of exceptions.

Definition at line 720 of file GaudiCommon.h.

m_format1

template<class PBASE>

Gaudi::Property<std::string> GaudiCommon< PBASE >::m_format1

private

Initial value:

{
      this, "RegularRowFormat", " | %|-48.48s|%|50t||%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |%|#12.5g| |%|#12.5g| |",
      "the format for regular row in the output Stat-table"}

Definition at line 765 of file GaudiCommon.h.

m_format2

template<class PBASE>

Gaudi::Property<std::string> GaudiCommon< PBASE >::m_format2

private

Initial value:

{
      this, "EfficiencyRowFormat",
      " |*%|-48.48s|%|50t||%|10d| |%|11.5g| |(%|#9.6g| +- %|-#9.6g|)%%|   -------   |   -------   |",
      "The format for \"efficiency\" row in the output Stat-table"}

Definition at line 768 of file GaudiCommon.h.

m_header

template<class PBASE>

Gaudi::Property<std::string> GaudiCommon< PBASE >::m_header

private

Initial value:

{this, "StatTableHeader",
                                        " |    Counter                                      |     #     |   "
                                        " sum     | mean/eff^* | rms/err^*  |     min     |     max     |",
                                        "the header row for the output Stat-table"}

Definition at line 761 of file GaudiCommon.h.

m_infos

template<class PBASE>

Counter GaudiCommon< PBASE >::m_infos

mutableprivate

counter of infos

Definition at line 718 of file GaudiCommon.h.

m_managedTools

template<class PBASE>

AlgTools GaudiCommon< PBASE >::m_managedTools

mutableprivate

List of active tools.

Definition at line 705 of file GaudiCommon.h.

m_printEmptyCounters

template<class PBASE>

Gaudi::Property<bool> GaudiCommon< PBASE >::m_printEmptyCounters

private

Initial value:

{this, "PrintEmptyCounters", false,
                                             "force printing of empty counters, otherwise only printed in DEBUG mode"}

Definition at line 756 of file GaudiCommon.h.

m_propsPrint

template<class PBASE>

Gaudi::Property<bool> GaudiCommon< PBASE >::m_propsPrint

private

Initial value:

{this, "PropertiesPrint", false,
                                     [this]( auto& ) {
                                       
                                       if ( this->FSMState() >= Gaudi::StateMachine::INITIALIZED &&
                                            this->propsPrint() ) {
                                         this->printProps( MSG::ALWAYS );
                                       }
                                     },
                                     "print the properties of the component"}

Definition at line 739 of file GaudiCommon.h.

m_services

template<class PBASE>

Services GaudiCommon< PBASE >::m_services

mutableprivate

List of active services.

Definition at line 707 of file GaudiCommon.h.

m_statEntityList

template<class PBASE>

Gaudi::Property<std::vector<std::string> > GaudiCommon< PBASE >::m_statEntityList

private

Initial value:

{
      this, "StatEntityList", {}, "RegEx list, of StatEntity counters for CounterSummary"}

Definition at line 777 of file GaudiCommon.h.

m_statPrint

template<class PBASE>

Gaudi::Property<bool> GaudiCommon< PBASE >::m_statPrint

private

Initial value:

{this, "StatPrint", true,
                                    [this]( auto& ) {
                                      
                                      if ( this->FSMState() >= Gaudi::StateMachine::INITIALIZED && this->statPrint() ) {
                                        this->printStat( MSG::ALWAYS );
                                      }
                                    },
                                    "print the table of counters"}

Definition at line 748 of file GaudiCommon.h.

m_typePrint

template<class PBASE>

Gaudi::Property<bool> GaudiCommon< PBASE >::m_typePrint {this, "TypePrint", true, "add the actual C++ component type into the messages"}

private

Definition at line 758 of file GaudiCommon.h.

m_updMgrSvc

template<class PBASE>

IUpdateManagerSvc* GaudiCommon< PBASE >::m_updMgrSvc = nullptr

mutableprivate

Pointer to the Update Manager Service instance.

Definition at line 727 of file GaudiCommon.h.

m_useEffFormat

template<class PBASE>

Gaudi::Property<bool> GaudiCommon< PBASE >::m_useEffFormat

private

Initial value:

{this, "UseEfficiencyRowFormat", true,
                                       "use the special format for printout of efficiency counters"}

Definition at line 772 of file GaudiCommon.h.

m_warnings

template<class PBASE>

Counter GaudiCommon< PBASE >::m_warnings

mutableprivate

counter of warnings

Definition at line 716 of file GaudiCommon.h.

UseRootInTES

template<class PBASE>

const bool GaudiCommon< PBASE >::UseRootInTES = true

staticprotected

Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.

If used with cause the RootInTES option to be USED

Useful to aid with code readability. e.g.

// Get data, using the setting of rootInTES()
MyData * data = get<MyData>( "/Event/MyData", UseRootInTES );
// note the default setting is true, so this is equivalent to
MyData * data = get<MyData>( "/Event/MyData" );

Definition at line 120 of file GaudiCommon.h.

---

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

• GaudiAlg/GaudiAlg/GaudiCommon.h
• GaudiAlg/GaudiAlg/GaudiCommonImp.h
• GaudiAlg/src/lib/GaudiCommon.icpp