AthAsgExUnittestAlg Class Reference

#include <AthAsgExUnittestAlg.h>

Inheritance diagram for AthAsgExUnittestAlg:

Collaboration diagram for AthAsgExUnittestAlg:

Public Member Functions
	AthAsgExUnittestAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~AthAsgExUnittestAlg ()
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) override
	Execute method.
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Function initialising the tool in the correct way in Athena.
virtual StatusCode	sysExecute (const EventContext &) override
	override to do firstEvent method
template<typename T>
StatusCode	retrieveMetadata (const std::string &folder, const std::string &key, T &out)
	Helper function to access IOVMetaDataContainer information helped in the MetaDataStore.
template<typename T>
StatusCode	retrieveMetadata (const std::string &folder, const std::string &key, T &out, const IOVTime &time, int channel=-1)
	Helper function to access IOVMetaDataContainer information held in InputMetaDataStore, but will check IOVTime.
const ServiceHandle< ITHistSvc > &	histSvc () const
	The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Functions providing access to the input/output metadata
const ServiceHandle< StoreGateSvc > &	inputMetaStore () const
	Const accessor for the input metadata store.
ServiceHandle< StoreGateSvc > &	inputMetaStore ()
	Accessor for the input metadata store.
const ServiceHandle< StoreGateSvc > &	outputMetaStore () const
	Const accessor for the output metadata store.
ServiceHandle< StoreGateSvc > &	outputMetaStore ()
	Accessor for the output metadata store.

Protected Member Functions
void	updateEvtStore (Gaudi::Details::PropertyBase &prop)
virtual void	handle (const Incident &inc) override
	Function receiving incidents from IncidentSvc/TEvent Experts can override but they should ensure they add AthAnalysisAlgorithm::handle(); to the end of their own implementation.
virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened user can read input metadata from inputMetaStore().
virtual StatusCode	endInputFile ()
	Function called as an input file is being closed.
virtual StatusCode	metaDataStop ()
	Function called before finalize user can read output metadata from outputMetaStore().
virtual StatusCode	firstExecute ()
	Function called when first execute is encountered user can read event information with evtStore().
virtual TFile *	currentFile (const char *evtSelName="EventSelector") final
	Function returning the TFile pointer of the currently open file of the given EventSelector (in athena jobs this defaults to "EventSelector").
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.
StatusCode	configAthHistogramming (const ServiceHandle< ITHistSvc > &histSvc, const std::string &prefix, const std::string &rootDir, const std::string &histNamePrefix, const std::string &histNamePostfix, const std::string &histTitlePrefix, const std::string &histTitlePostfix)
	To be called to fill the internal configuration.
TH1 *	bookGetPointer (const TH1 &hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 *hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 &histRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TTree *	bookGetPointer (const TTree &treeRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
TGraph *	bookGetPointer (const TGraph &graphRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
TEfficiency *	bookGetPointer (const TEfficiency &eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency *eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency &effRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (const TH1 &hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 *hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 &histRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (const TTree &treeRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
StatusCode	book (const TGraph &graphRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
StatusCode	book (const TEfficiency &eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency *eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency &effRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TH1 *	hist (std::string_view histName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered histograms of any type.
TH2 *	hist2d (std::string_view histName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered 2-d histograms.
TH3 *	hist3d (std::string_view histName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered 3-d histograms.
TTree *	tree (std::string_view treeName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered TTrees.
TGraph *	graph (std::string_view graphName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered TGraphs.
TEfficiency *	efficiency (std::string_view effName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered TEfficiency.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t
typedef uint32_t	hash_t
	typedef for the internal hash
typedef std::map< const hash_t, TH1 * >	HistMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TEfficiency * >	EffMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TTree * >	TreeMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TGraph * >	GraphMap_t
	Typedef for convenience.

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>
std::string	buildBookingString (std::string_view histName, std::string_view tDir, std::string_view stream, bool usePrefixPostfix=false) const
	Method to build individual booking string.
hash_t	hash (std::string_view histName) const
	Method to calculate a 32-bit hash from a string.

Private Attributes
Gaudi::Property< int >	m_property {this, "MyProperty", 1}
ToolHandle< IAthAsgExUnittestTool >	m_tool {this, "MyTool", "AthAsgExUnittestTool/MyTool"}
ServiceHandle< StoreGateSvc >	m_inputMetaStore
	Object accessing the input metadata store.
ServiceHandle< StoreGateSvc >	m_outputMetaStore
	Object accessing the output metadata store.
TFile *	m_currentFile {nullptr}
bool	m_doneFirstEvent {false}
ServiceHandle< ITHistSvc >	m_histSvc
	Default constructor: AthHistogramAlgorithm();.
std::string	m_prefix
	Name of the ROOT output stream (file).
std::string	m_rootDir
	Name of the ROOT directory.
std::string	m_histNamePrefix
	The prefix for the histogram THx name.
std::string	m_histNamePostfix
	The postfix for the histogram THx name.
std::string	m_histTitlePrefix
	The prefix for the histogram THx title.
std::string	m_histTitlePostfix
	The postfix for the histogram THx title.
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
HistMap_t	m_histMap
	The map of histogram names to their pointers.
EffMap_t	m_effMap
	The map of histogram names to their pointers.
TreeMap_t	m_treeMap
	The map of TTree names to their pointers.
GraphMap_t	m_graphMap
	The map of TGraph names to their pointers.
std::string	m_streamName
	Name of the ROOT output stream (file).
std::string	m_name
	Instance name.
MsgStream	m_msg
	Cached Message Stream.

Detailed Description

Definition at line 18 of file AthAsgExUnittestAlg.h.

Member Typedef Documentation

EffMap_t

typedef std::map< const hash_t, TEfficiency* > AthHistogramming::EffMap_t

privateinherited

Typedef for convenience.

Definition at line 199 of file AthHistogramming.h.

GraphMap_t

typedef std::map< const hash_t, TGraph* > AthHistogramming::GraphMap_t

privateinherited

Typedef for convenience.

Definition at line 213 of file AthHistogramming.h.

hash_t

typedef uint32_t AthHistogramming::hash_t

privateinherited

typedef for the internal hash

Definition at line 171 of file AthHistogramming.h.

HistMap_t

typedef std::map< const hash_t, TH1* > AthHistogramming::HistMap_t

privateinherited

Typedef for convenience.

Definition at line 192 of file AthHistogramming.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

TreeMap_t

typedef std::map< const hash_t, TTree* > AthHistogramming::TreeMap_t

privateinherited

Typedef for convenience.

Definition at line 206 of file AthHistogramming.h.

Constructor & Destructor Documentation

AthAsgExUnittestAlg()

AthAsgExUnittestAlg::AthAsgExUnittestAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 10 of file AthAsgExUnittestAlg.cxx.

                                           : 
  AthAnalysisAlgorithm( name, pSvcLocator ) {
  addRef(); // workaround until fix in Gaudi
}

~AthAsgExUnittestAlg()

AthAsgExUnittestAlg::~AthAsgExUnittestAlg ( )

virtual

Definition at line 17 of file AthAsgExUnittestAlg.cxx.

{}

Member Function Documentation

beginInputFile()

StatusCode AthAnalysisAlgorithm::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened user can read input metadata from inputMetaStore().

Dummy implementation that can be overridden by the derived tool.

Reimplemented in MuonVal::MetaDataAlg.

Definition at line 114 of file AthAnalysisAlgorithm.cxx.

                                                {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

book() [1/8]

StatusCode AthHistogramming::book ( const TEfficiency & eff, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 329 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TEfficiency* effClone = dynamic_cast< TEfficiency* >( eff.Clone() );
  if ( !effClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *effClone, tDir, stream );
}

book() [2/8]

StatusCode AthHistogramming::book ( const TGraph & graphRef, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

book() [3/8]

StatusCode AthHistogramming::book ( const TH1 & hist, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 297 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TH1 clone" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *histClone, tDir, stream );
}

book() [4/8]

StatusCode AthHistogramming::book ( const TTree & treeRef, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 397 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TTree* treePointer = this->bookGetPointer( treeRef, tDir, stream );
  if ( treePointer )
    {
      return StatusCode::SUCCESS;
    }
  else
    {
      return StatusCode::FAILURE;
    }
}

book() [5/8]

StatusCode AthHistogramming::book ( TEfficiency & effRef, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 350 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TEfficiency* effPointer = this->bookGetPointer( effRef, tDir, stream );
  if ( !effPointer ) {
    m_msg << MSG::ERROR << "Couldn't book a TEfficiency" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

book() [6/8]

StatusCode AthHistogramming::book ( TEfficiency * eff, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 340 of file AthHistogramming.h.

{
  if ( !eff ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *eff, tDir, stream );
}

book() [7/8]

StatusCode AthHistogramming::book ( TH1 & histRef, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 318 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TH1* histPointer = this->bookGetPointer( histRef, tDir, stream );
  if ( !histPointer ) {
    m_msg << MSG::ERROR << "Couldn't book a TH1" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

book() [8/8]

StatusCode AthHistogramming::book ( TH1 * hist, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 308 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TH1" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *hist, tDir, stream );
}

bookGetPointer() [1/8]

TEfficiency * AthHistogramming::bookGetPointer ( const TEfficiency & eff, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 275 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TEfficiency* histClone = dynamic_cast< TEfficiency* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *histClone, tDir, stream );
 
}

bookGetPointer() [2/8]

TGraph * AthHistogramming::bookGetPointer ( const TGraph & graphRef, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

Definition at line 374 of file AthHistogramming.cxx.

{
  // Get a pointer
  const TGraph* graphPointer = &graphRef;
 
  // Check that we got a valid pointer
  if ( !graphPointer )
    {
      m_msg << MSG::WARNING
            << "We got an invalid TGraph pointer in the BookGetPointer(TGraph*) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
 
  // Modify the name and title according to the prefixes of this classes instance
  std::string graphName  = graphPointer->GetName();
  const std::string graphTitle = graphPointer->GetTitle();
 
  // Check if the hash for this graphName already exists, i.e., if we have a hash collision
  const hash_t graphHash = this->hash(graphName);
  GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
  if ( it != m_graphMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TGraph with name=" << graphName
            << " already exists and points to a TGraph with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Create a clone that has the new name
  TGraph* graphClone = dynamic_cast< TGraph* >( graphPointer->Clone((m_histNamePrefix+graphName+m_histNamePostfix).c_str()) );
  if( !graphClone )
    {
      m_msg << MSG::WARNING
            << "We couldn't clone the TGraph in the BookGetPointer(TGraph&) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
  graphClone->SetTitle ((m_histTitlePrefix+graphTitle+m_histTitlePostfix).c_str());
 
  // Massage the final string to book things
  std::string bookingString = buildBookingString( graphName, tDir, stream );
 
  // Register the TGraph into the THistSvc
  if ( !((histSvc()->regGraph(bookingString, graphClone)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TGraph with name " << graphName
            << ", title " << graphTitle
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphClone ) );
 
  return graphClone;
}

bookGetPointer() [3/8]

TH1 * AthHistogramming::bookGetPointer ( const TH1 & hist, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 254 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TH1 clone in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *histClone, tDir, stream );
 
}

bookGetPointer() [4/8]

TTree * AthHistogramming::bookGetPointer ( const TTree & treeRef, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 268 of file AthHistogramming.cxx.

{
  // Get a pointer
  const TTree* treePointer = &treeRef;
 
  // Check that we got a valid pointer
  if ( !treePointer )
    {
      m_msg << MSG::WARNING
            << "We got an invalid TTree pointer in the BookGetPointer(TTree*) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
 
  // Modify the name and title according to the prefixes of this classes instance
  std::string treeName  = treePointer->GetName();
  const std::string treeTitle = treePointer->GetTitle();
 
  // Check if the hash for this treeName already exists, i.e., if we have a hash collision
  const hash_t treeHash = this->hash(treeName);
  TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
  if ( it != m_treeMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TTree with name=" << treeName
            << " already exists and points to a TTree with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Create a clone that has the new name
  TTree* treeClone = dynamic_cast< TTree* >( treePointer->Clone(treeName.c_str()) );
  if( !treeClone )
    {
      m_msg << MSG::WARNING
            << "We couldn't clone the TTree in the BookGetPointer(TTree&) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
  treeClone->SetTitle (treeTitle.c_str());
 
  // Massage the final string to book things
  std::string bookingString = buildBookingString( treeName, tDir, stream );
 
  // Register the TTree into the THistSvc
  if ( !((histSvc()->regTree(bookingString, treeClone)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TTree with name " << treeName
            << ", title " << treeTitle
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treeClone ) );
 
  return treeClone;
}

bookGetPointer() [5/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency & effRef, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 139 of file AthHistogramming.cxx.

{
  std::string originalName{effRef.GetName()};
  const auto effName = splitName(originalName).second;
  const std::string effTitle(effRef.GetTitle());
  std::string bookingString = buildBookingString(originalName, tDir, stream);
  std::string finalEffName{m_histNamePrefix};
  finalEffName += effName;
  finalEffName += m_histNamePostfix;
  effRef.SetTitle((m_histTitlePrefix + effTitle + m_histTitlePostfix).c_str());
  effRef.SetName(finalEffName.c_str());
 
  const hash_t effHash = this->hash(effName);
  EffMap_t::const_iterator it = m_effMap.find(effHash);
  if (it != m_effMap.end()) {
    m_msg << MSG::WARNING
          << "Detected a hash collision. The hash for the TEfficiency with name=" << effName
          << " already exists and points to a TEfficiency with name=" << it->second->GetName()
          << " NOT going to book the new TEfficiency and returning a NULL pointer!" << endmsg;
    return nullptr;
  }
 
  if (!histSvc()->regEfficiency(bookingString, &effRef).isSuccess()) {
    m_msg << MSG::WARNING
          << "Problem registering TEfficiency with name " << effName
          << ", name prefix " << m_histNamePrefix
          << ", title " << effTitle
          << ", title prefix " << m_histTitlePrefix
          << ", and title postfix " << m_histTitlePostfix
          << " in " << m_name << "!" << endmsg;
    return nullptr;
  }
 
  m_effMap.insert(m_effMap.end(), std::pair<const hash_t, TEfficiency*>(effHash, &effRef));
 
  return &effRef;
}

bookGetPointer() [6/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency * eff, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 287 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *hist, tDir, stream );
}

bookGetPointer() [7/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 & histRef, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 97 of file AthHistogramming.cxx.

                                                                                          {
  
  const std::string originalName{histRef.GetName()};
  const auto histName = splitName(originalName).second;
  
  const std::string histTitle(histRef.GetTitle());
  std::string bookingString = buildBookingString(originalName, tDir, stream);
 
  std::string finalHistName{m_histNamePrefix};
  finalHistName += histName;
  finalHistName += m_histNamePostfix;
 
  histRef.SetTitle((m_histTitlePrefix + histTitle + m_histTitlePostfix).c_str());
  histRef.SetName(finalHistName.c_str());
 
  const hash_t histHash = this->hash(histName);
  HistMap_t::const_iterator it = m_histMap.find(histHash);
  if (it != m_histMap.end()) {
    m_msg << MSG::WARNING
          << "Detected a hash collision. The hash for the histogram with name=" << histName
          << " already exists and points to a histogram with name=" << it->second->GetName()
          << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
    return nullptr;
  }
 
  if (!histSvc()->regHist(bookingString, &histRef).isSuccess()) {
    m_msg << MSG::WARNING
          << "Problem registering histogram with name " << histName
          << ", name prefix " << m_histNamePrefix
          << ", title " << histTitle
          << ", title prefix " << m_histTitlePrefix
          << ", and title postfix " << m_histTitlePostfix
          << " in " << m_name << "!" << endmsg;
    return nullptr;
  }
 
  m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, &histRef));
 
  return &histRef;
}

bookGetPointer() [8/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 * hist, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 266 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TH1 in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *hist, tDir, stream );
}

buildBookingString()

std::string AthHistogramming::buildBookingString ( std::string_view histName, std::string_view tDir, std::string_view stream, bool usePrefixPostfix = false ) const

privateinherited

Method to build individual booking string.

Definition at line 500 of file AthHistogramming.cxx.

                                                     {
  if (tDir.empty()) {
    tDir = m_rootDir;
  }
  if (stream.empty()) {
    stream = m_streamName;
  }
  const auto [histDir, baseName] = splitName(histName);
  std::string bookingString{"/"};
  bookingString += stream;
  bookingString += '/';
  bookingString += tDir;
  if (!histDir.empty()) {
    bookingString += '/';
    bookingString += histDir;
  }
  bookingString += '/';
  if (usePrefixPostfix) {
    bookingString += m_histNamePrefix;
  }
  bookingString += baseName;
  if (usePrefixPostfix) {
    bookingString += m_histNamePostfix;
  }
  const auto tail = std::ranges::unique(
    bookingString, [](char lhs, char rhs) { return lhs == '/' && rhs == '/'; });
  bookingString.erase(tail.begin(), tail.end());
  return bookingString;
}

configAthHistogramming()

StatusCode AthHistogramming::configAthHistogramming ( const ServiceHandle< ITHistSvc > & histSvc, const std::string & prefix, const std::string & rootDir, const std::string & histNamePrefix, const std::string & histNamePostfix, const std::string & histTitlePrefix, const std::string & histTitlePostfix )

protectedinherited

To be called to fill the internal configuration.

Definition at line 64 of file AthHistogramming.cxx.

{
  m_histSvc          = histSvc;
  m_streamName       = prefix;
  m_rootDir          = rootDir;
  m_histNamePrefix   = histNamePrefix;
  m_histNamePostfix  = histNamePostfix;
  m_histTitlePrefix  = histTitlePrefix;
  m_histTitlePostfix = histTitlePostfix;
 
  return StatusCode::SUCCESS;
}

currentFile()

TFile * AthAnalysisAlgorithm::currentFile ( const char * evtSelName = "EventSelector" )

finalprotectedvirtualinherited

Function returning the TFile pointer of the currently open file of the given EventSelector (in athena jobs this defaults to "EventSelector").

Definition at line 147 of file AthAnalysisAlgorithm.cxx.

                                                               {
   if(m_currentFile) return m_currentFile;
 
   //get the EventSelector so we can get it's list of input files
   //dont get it with a ServiceHandle, because that invokes initialize, can get into init loop
 
   SmartIF<IProperty> evtSelector{service(evtSelName, false)};
   if(!evtSelector) {
     ATH_MSG_ERROR("currentFile(): Couldn't find the service: " << evtSelName);return 0;
   }
 
   try {
      //get the list of input files - use this to determine which open file is the current input file
      const StringArrayProperty& inputCollectionsName = dynamic_cast<const StringArrayProperty&>(evtSelector->getProperty("InputCollections"));
 
      ATH_MSG_VERBOSE("nOpenFile=" << gROOT->GetListOfFiles()->GetSize() << ". nFilesInInputCollection=" << inputCollectionsName.value().size());
      if(msgLvl(MSG::VERBOSE)) {
          for(int i=0;i<gROOT->GetListOfFiles()->GetSize();i++) {
            ATH_MSG_VERBOSE("Open file: " << gROOT->GetListOfFiles()->At(i)->GetName());
          }
      }
 
      //look through list of files and find the one from the input collection that is currently open
 
      for(int i=0;i<gROOT->GetListOfFiles()->GetSize();i++) {
            TFile *g = (TFile*)gROOT->GetListOfFiles()->At(i);
            //see if this file is in the input file list
            //strip everything except stuff either side of last /
            TString s(g->GetName());
            TObjArray* tokens = s.Tokenize("/");
            TObjString* lastToken = static_cast<TObjString*>(tokens->Last());
            TString sToCompare("");
            bool shortComparison(false);
            if(tokens->GetEntries()>1) {
                TString beforeSlash((static_cast<TObjString*>(tokens->At(tokens->GetEntries()-2)))->GetString());
                if(beforeSlash.Length()>0) sToCompare += beforeSlash;
                sToCompare += "/";
            } else {
                shortComparison=true;
            }
            sToCompare += lastToken->GetString();
            TString sToCompare_short(lastToken->GetString()); //short versions search
            delete tokens;
 
            for(unsigned int j=0;j<inputCollectionsName.value().size();j++) {
                TString t(inputCollectionsName.value()[j].c_str());
                //try perfect match first
                if(s.EqualTo(t)) {
                  ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                  m_currentFile = g;
                  return g;
                }
                TObjArray* tokens = t.Tokenize("/");
                TObjString* lastToken = dynamic_cast<TObjString*>(tokens->Last());
                if (!lastToken) {
                  ATH_MSG_ERROR("Cannot cast token string to TObjString");
                  return nullptr;
                }
                TString tToCompare = "";
                bool shortComparison2(false);
                if(tokens->GetEntries()>1) {
                  TObjString* beforeSlashStr = dynamic_cast<TObjString*>(tokens->At(tokens->GetEntries()-2));
                  if (!beforeSlashStr) {
                    ATH_MSG_ERROR("Cannot cast token string to TObjString");
                    return nullptr;
                  }
                  TString beforeSlash(beforeSlashStr->GetString());
                  if(beforeSlash.Length()>0) tToCompare += beforeSlash;
                  tToCompare += "/";
                } else {
                  shortComparison2=true;
                }
                tToCompare += lastToken->GetString();
                TString tToCompare_short(lastToken->GetString());
                delete tokens;
 
                if(shortComparison || shortComparison2) { //doing short version search, no directories to distinguish files!
                  if(sToCompare_short.EqualTo(tToCompare_short)) {
                      ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                      m_currentFile = g;
                      return g;
                  }
                } else
                if(sToCompare.EqualTo(tToCompare)) {
                  ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                  m_currentFile=g;
                  return g;
                }
            }
      }
 
   } catch(...) {
     ATH_MSG_ERROR("currentFile(): Couldn't load InputCollections property of " << evtSelName); return 0;
   }
 
   ATH_MSG_ERROR("currentFile(): Could not find the current file!");
   return 0; //something went wrong :-(
 
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

efficiency()

TEfficiency * AthHistogramming::efficiency ( std::string_view effName, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the retrieval of registered TEfficiency.

Definition at line 214 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t effHash = this->hash(effName);
 
  // See if this entry exists in the map
  EffMap_t::const_iterator it = m_effMap.find( effHash );
  if ( it == m_effMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TEfficiency...
      // Massage the final string to book things
      std::string bookingString = buildBookingString(effName, tDir, stream ,false);
 
      TEfficiency* effPointer{};
      if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
        {
          // Book things
          std::string bookingString = buildBookingString( effName, tDir, stream, true );
 
          if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TEfficiency with name (including pre- and post-fixes) "
                    << bookingString
                    << " or with name " << effName
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return NULL;
            }
          // If we get to here, we actually found the TEfficiency in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
          return effPointer;
        }
      // If we get to here, we actually found the TEfficiency in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
      return effPointer;
    }
 
  // Return the pointer to the TEfficiency that we got from the local cache map
  return it->second;
}

endInputFile()

StatusCode AthAnalysisAlgorithm::endInputFile ( )

protectedvirtualinherited

Function called as an input file is being closed.

Dummy implementation that can be overridden by the derived tool.

Definition at line 122 of file AthAnalysisAlgorithm.cxx.

                                              {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode AthAsgExUnittestAlg::execute ( const EventContext & ctx )

overridevirtual

Execute method.

Implements AthAlgorithm.

Definition at line 32 of file AthAsgExUnittestAlg.cxx.

                                                               {
  ATH_MSG_DEBUG( "Executing {}...", name() );
  setFilterPassed(false, ctx); //optional: start with algorithm not passed
 
  // Real algorithm here
 
  setFilterPassed(true, ctx); //if got here, assume that means algorithm passed
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 89 of file AthCommonAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

finalize()

StatusCode AthAsgExUnittestAlg::finalize ( )

overridevirtual

Definition at line 27 of file AthAsgExUnittestAlg.cxx.

                                         {
  ATH_MSG_INFO( "Finalizing {}...", name() );
  return StatusCode::SUCCESS;
}

firstExecute()

StatusCode AthAnalysisAlgorithm::firstExecute ( )

protectedvirtualinherited

Function called when first execute is encountered user can read event information with evtStore().

Dummy implementation that can be overridden by the derived tool.

Reimplemented in CP::JetTileCorrectionAlg.

Definition at line 139 of file AthAnalysisAlgorithm.cxx.

                                              {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

graph()

TGraph * AthHistogramming::graph ( std::string_view graphName, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the retrieval of registered TGraphs.

Definition at line 438 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t graphHash = this->hash(graphName);
 
  // See if this entry exists in the map
  GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
  if ( it == m_graphMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TGraph...
 
      // Massage the final string to book things
      std::string bookingString = buildBookingString( graphName, tDir, stream, false);
 
      TGraph* graphPointer(nullptr);
      if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString = buildBookingString( graphName, tDir, stream, true );
 
          if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TGraph with name (including pre- and post-fixes) "
                    << bookingString
                    << " or with name " << graphName
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return nullptr;
            }
          // If we get to here, we actually found the TGraph in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
          return graphPointer;
        }
      // If we get to here, we actually found the TGraph in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
      return graphPointer;
    }
 
 
  // Return the pointer to the TGraph that we got from the local cache map
  return it->second;
}

handle()

void AthAnalysisAlgorithm::handle ( const Incident & inc )

overrideprotectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent Experts can override but they should ensure they add AthAnalysisAlgorithm::handle(); to the end of their own implementation.

Definition at line 83 of file AthAnalysisAlgorithm.cxx.

                                                       {
 
   // Tell the user what's happening:
   ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
 
   // Call the appropriate member function:
   if( inc.type() == IncidentType::BeginInputFile ) {
      m_currentFile=0;
      if( beginInputFile().isFailure() ) {
         ATH_MSG_FATAL( "Failed to call beginInputFile()" );
         throw std::runtime_error( "Couldn't call beginInputFile()" );
      }
   } else if(inc.type() == IncidentType::EndInputFile ) {
     if( endInputFile().isFailure() ) {
         ATH_MSG_FATAL( "Failed to call endInputFile()" );
         throw std::runtime_error( "Couldn't call endInputFile()" );
      }
   } else if(inc.type() == "MetaDataStop" ) {
     if( metaDataStop().isFailure() ) {
         ATH_MSG_FATAL( "Failed to call metaDataStop()" );
         throw std::runtime_error( "Couldn't call metaDataStop()" );
      }
   } else {
      ATH_MSG_WARNING( "Unknown incident type received: " << inc.type() );
   }
 
   return;
}

hash()

AthHistogramming::hash_t AthHistogramming::hash ( std::string_view histName ) const

inlineprivateinherited

Method to calculate a 32-bit hash from a string.

Definition at line 422 of file AthHistogramming.h.

{
  const uint64_t hash64 = CxxUtils::crc64( std::string{histName} );
  return (hash_t)(hash64 & 0xFFFFFFFF);
}

hist()

TH1 * AthHistogramming::hist ( std::string_view histName, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the retrieval of registered histograms of any type.

Definition at line 182 of file AthHistogramming.cxx.

                       {
 
  const auto histBaseName = splitName(histName).second;
  std::string bookingString = buildBookingString(histName, tDir, stream, false);
 
  const hash_t histHash = this->hash(histBaseName);
 
  HistMap_t::const_iterator it = m_histMap.find(histHash);
  if (it == m_histMap.end()) {
    TH1* histPointer(nullptr);
 
    if (!histSvc()->getHist(bookingString, histPointer).isSuccess()) {
      std::string prefixedBookingString = buildBookingString(histName, tDir, stream, true);
      if (!histSvc()->getHist(prefixedBookingString, histPointer).isSuccess()) {
        m_msg << MSG::WARNING
              << "Problem retrieving the histogram with name (including pre- and post-fixes) "
              << prefixedBookingString
              << " or with name " << histName
              << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
              << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
        return nullptr;
      }
    }
 
    m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, histPointer));
    return histPointer;
  }
 
  return it->second;
}

hist2d()

TH2 * AthHistogramming::hist2d ( std::string_view histName, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 2-d histograms.

Definition at line 363 of file AthHistogramming.h.

{
  // Get the TH1 pointer
  TH1* th1Pointer = this->hist(histName, tDir, stream);
  if ( !th1Pointer )
    {
      m_msg << MSG::ERROR
            << "Cannot get a 2-d histogram with name " << histName
            << "... will probably seg-fault!" << endmsg;
      return NULL;
    }
  // If the TH1 pointer is valid, simply return the dynamic_cast
  return dynamic_cast<TH2*>( th1Pointer );
}

hist3d()

TH3 * AthHistogramming::hist3d ( std::string_view histName, std::string_view tDir = "", std::string_view stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 3-d histograms.

Definition at line 380 of file AthHistogramming.h.

{
  // Get the TH1 pointer
  TH1* th1Pointer = this->hist(histName, tDir, stream);
  if ( !th1Pointer )
    {
      m_msg << MSG::ERROR
            << "Cannot get a 3-d histogram with name " << histName
            << "... will probably seg-fault!" << endmsg;
      return NULL;
    }
  // If the TH1 pointer is valid, simply return the dynamic_cast
  return dynamic_cast<TH3*>( th1Pointer );
}

histSvc()

const ServiceHandle< ITHistSvc > & AthHistogramAlgorithm::histSvc ( ) const

inlineinherited

The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.

Definition at line 113 of file AthHistogramAlgorithm.h.

{
  return m_histSvc;
}

initialize()

StatusCode AthAsgExUnittestAlg::initialize ( )

overridevirtual

Definition at line 20 of file AthAsgExUnittestAlg.cxx.

                                           {
  ATH_MSG_INFO( "Initializing {}...", name() );
  ATH_MSG_INFO( "MyProperty = {}", m_property );
  CHECK(m_tool.retrieve());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

inputMetaStore() [1/2]

ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::inputMetaStore ( )

inlineinherited

Accessor for the input metadata store.

Definition at line 51 of file AthAnalysisAlgorithm.h.

{ return m_inputMetaStore; }

inputMetaStore() [2/2]

const ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::inputMetaStore ( ) const

inlineinherited

Const accessor for the input metadata store.

Definition at line 49 of file AthAnalysisAlgorithm.h.

{ return m_inputMetaStore; }

isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

{ return false; }

metaDataStop()

StatusCode AthAnalysisAlgorithm::metaDataStop ( )

protectedvirtualinherited

Function called before finalize user can read output metadata from outputMetaStore().

Dummy implementation that can be overridden by the derived tool.

Definition at line 130 of file AthAnalysisAlgorithm.cxx.

                                              {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

outputMetaStore() [1/2]

ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::outputMetaStore ( )

inlineinherited

Accessor for the output metadata store.

Definition at line 55 of file AthAnalysisAlgorithm.h.

{ return m_outputMetaStore; }

outputMetaStore() [2/2]

const ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::outputMetaStore ( ) const

inlineinherited

Const accessor for the output metadata store.

Definition at line 53 of file AthAnalysisAlgorithm.h.

{ return m_outputMetaStore; }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

retrieveMetadata() [1/2]

template<typename T>

StatusCode AthAnalysisAlgorithm::retrieveMetadata ( const std::string & folder, const std::string & key, T & out )

inlineinherited

Helper function to access IOVMetaDataContainer information helped in the MetaDataStore.

Definition at line 65 of file AthAnalysisAlgorithm.h.

                                                                                                            {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore());
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }

retrieveMetadata() [2/2]

template<typename T>

StatusCode AthAnalysisAlgorithm::retrieveMetadata ( const std::string & folder, const std::string & key, T & out, const IOVTime & time, int channel = -1 )

inlineinherited

Helper function to access IOVMetaDataContainer information held in InputMetaDataStore, but will check IOVTime.

Also can give a channel (leave as -1 to take first available) IOVTime(runNumber, eventNumber) is a valid constructor for example

Definition at line 76 of file AthAnalysisAlgorithm.h.

                                                                                                                                               {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore(),time,channel);
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }

setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Set filter decision:

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthAnalysisAlgorithm::sysExecute ( const EventContext & ctx )

overridevirtualinherited

override to do firstEvent method

Reimplemented from AthCommonAlgorithm< Gaudi::Algorithm >.

Definition at line 72 of file AthAnalysisAlgorithm.cxx.

                                                                   {
  if(!m_doneFirstEvent) {
    m_doneFirstEvent=true;
    if( firstExecute().isFailure() ) {
      ATH_MSG_FATAL("Failure in firstEvent method");
      return StatusCode::FAILURE;
    }
  }
  return AthHistogramAlgorithm::sysExecute(ctx);
}

sysInitialize()

StatusCode AthAnalysisAlgorithm::sysInitialize ( )

overridevirtualinherited

Function initialising the tool in the correct way in Athena.

Reimplemented from AthHistogramAlgorithm.

Definition at line 50 of file AthAnalysisAlgorithm.cxx.

                                               {
 
      // Connect to the IncidentSvc:
      ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
      ATH_CHECK( incSvc.retrieve() );
 
      // Set up the right callbacks: //but ensure we don't double-register if sysInitialize called twice (appears to be the case)
      incSvc->removeListener( this, IncidentType::BeginInputFile );
      incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
      incSvc->removeListener( this, IncidentType::EndInputFile );
      incSvc->addListener( this, IncidentType::EndInputFile, 0, true );
      incSvc->removeListener( this, "MetaDataStop" );
      incSvc->addListener( this, "MetaDataStop", 0, true );
 
 
      // Let the base class do its thing:
      ATH_CHECK( AthHistogramAlgorithm::sysInitialize() );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

tree()

TTree * AthHistogramming::tree ( std::string_view treeName, std::string_view tDir = "", std::string_view stream = "" )

protectedinherited

Simplify the retrieval of registered TTrees.

Definition at line 333 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t treeHash = this->hash(treeName);
  // See if this entry exists in the map
  TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
  if ( it == m_treeMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TTree...
      // Massage the final string to book things
      std::string bookingString = buildBookingString( treeName, tDir, stream);
 
      TTree* treePointer(NULL);
      if ( !((histSvc()->getTree(bookingString, treePointer)).isSuccess()) )
        {
          m_msg << MSG::WARNING
                << "Problem retrieving the TTree with name " << treeName
                << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
          return NULL;
        }
      // If we get to here, we actually found the TTree in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treePointer ) );
      return treePointer;
    }
 
  // Return the pointer to the TTree that we got from the local cache map
  return it->second;
}

updateEvtStore()

void AthAnalysisAlgorithm::updateEvtStore ( Gaudi::Details::PropertyBase & prop )

protectedinherited

Definition at line 45 of file AthAnalysisAlgorithm.cxx.

                                                                        {
  evtStore().release().ignore(); 
  evtStore().setTypeAndName(prop.toString());
}

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_currentFile

TFile* AthAnalysisAlgorithm::m_currentFile {nullptr}

privateinherited

Definition at line 120 of file AthAnalysisAlgorithm.h.

{nullptr}; //used to cache the current file

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_doneFirstEvent

bool AthAnalysisAlgorithm::m_doneFirstEvent {false}

privateinherited

Definition at line 122 of file AthAnalysisAlgorithm.h.

{false};

m_effMap

EffMap_t AthHistogramming::m_effMap

privateinherited

The map of histogram names to their pointers.

Definition at line 202 of file AthHistogramming.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

m_graphMap

GraphMap_t AthHistogramming::m_graphMap

privateinherited

The map of TGraph names to their pointers.

Definition at line 216 of file AthHistogramming.h.

m_histMap

HistMap_t AthHistogramming::m_histMap

privateinherited

The map of histogram names to their pointers.

Definition at line 195 of file AthHistogramming.h.

m_histNamePostfix

std::string AthHistogramAlgorithm::m_histNamePostfix

privateinherited

The postfix for the histogram THx name.

Definition at line 97 of file AthHistogramAlgorithm.h.

m_histNamePrefix

std::string AthHistogramAlgorithm::m_histNamePrefix

privateinherited

The prefix for the histogram THx name.

Definition at line 94 of file AthHistogramAlgorithm.h.

m_histSvc

ServiceHandle<ITHistSvc> AthHistogramAlgorithm::m_histSvc

privateinherited

Default constructor: AthHistogramAlgorithm();.

a handle on the Hist/TTree registration service

Definition at line 83 of file AthHistogramAlgorithm.h.

m_histTitlePostfix

std::string AthHistogramAlgorithm::m_histTitlePostfix

privateinherited

The postfix for the histogram THx title.

Definition at line 103 of file AthHistogramAlgorithm.h.

m_histTitlePrefix

std::string AthHistogramAlgorithm::m_histTitlePrefix

privateinherited

The prefix for the histogram THx title.

Definition at line 100 of file AthHistogramAlgorithm.h.

m_inputMetaStore

ServiceHandle< StoreGateSvc > AthAnalysisAlgorithm::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 116 of file AthAnalysisAlgorithm.h.

m_msg

MsgStream AthHistogramming::m_msg

privateinherited

Cached Message Stream.

Definition at line 242 of file AthHistogramming.h.

m_name

std::string AthHistogramming::m_name

privateinherited

Instance name.

Definition at line 239 of file AthHistogramming.h.

m_outputMetaStore

ServiceHandle< StoreGateSvc > AthAnalysisAlgorithm::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 118 of file AthAnalysisAlgorithm.h.

m_prefix

std::string AthHistogramAlgorithm::m_prefix

privateinherited

Name of the ROOT output stream (file).

Definition at line 88 of file AthHistogramAlgorithm.h.

m_property

Gaudi::Property<int> AthAsgExUnittestAlg::m_property {this, "MyProperty", 1}

private

Definition at line 30 of file AthAsgExUnittestAlg.h.

{this, "MyProperty", 1};

m_rootDir

std::string AthHistogramAlgorithm::m_rootDir

privateinherited

Name of the ROOT directory.

Definition at line 91 of file AthHistogramAlgorithm.h.

m_streamName

std::string AthHistogramming::m_streamName

privateinherited

Name of the ROOT output stream (file).

Definition at line 220 of file AthHistogramming.h.

m_tool

ToolHandle<IAthAsgExUnittestTool> AthAsgExUnittestAlg::m_tool {this, "MyTool", "AthAsgExUnittestTool/MyTool"}

private

Definition at line 31 of file AthAsgExUnittestAlg.h.

{this, "MyTool", "AthAsgExUnittestTool/MyTool"};

m_treeMap

TreeMap_t AthHistogramming::m_treeMap

privateinherited

The map of TTree names to their pointers.

Definition at line 209 of file AthHistogramming.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• AthAsgExUnittestAlg.h
• AthAsgExUnittestAlg.cxx