AthenaMonManager Class Reference

An Algorithm that manages a set of modules, each inheriting from ManagedMonitorToolBase, by setting common configuration variables and organizing the output data. More...

#include <AthenaMonManager.h>

Inheritance diagram for AthenaMonManager:

Collaboration diagram for AthenaMonManager:

Classes
class	Imp

Public Types
enum	Environment_t {   user = 0 , noOutput , online , tier0 ,   tier0Raw , tier0ESD , AOD , altprod }
	An enumeration of the different types of running environment the monitoring application may be in. More...
enum	DataType_t {   userDefined = 0 , monteCarlo , collisions , cosmics ,   heavyIonCollisions }
	An enumeration of the different types of data the monitoring application may be running over. More...

Public Member Functions
	AthenaMonManager (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~AthenaMonManager ()
bool	forkedProcess ()
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) override
	Execute method.
virtual StatusCode	start () override
virtual StatusCode	stop () override
virtual std::string	fileKey () const
virtual void	passOwnership (TObject *h, const std::string &key)
	Pass ownership of a TObject to this manager so that it will be deleted appropriately.
virtual void	writeAndDelete (const std::string &key)
	If the TObject is owned by this manager, its Write() method is called and it is deleted.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
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

Static Public Member Functions
static Environment_t	envStringToEnum (const std::string &str)
	Converts a string to an Environment_t of the same name.
static DataType_t	dataTypeStringToEnum (const std::string &str)
	Converts a string to a DataType_t of the same name.
static Environment_t	environment ()
	Returns the running environment of the monitoring application to help ManagedMonitorToolBase objects determine which histograms to produce.
static DataType_t	dataType ()
	Returns the data type that the monitoring application is running over to help ManagedMonitorToolBase objects determine which histograms to produce.
static unsigned int	lumiBlockNumber ()
static unsigned int	runNumber ()
static unsigned int	fillNumber ()
static unsigned int	getLBsLowStat ()
static unsigned int	getLBsMedStat ()
static unsigned int	getLBsHigStat ()

Protected Member Functions
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.

Protected Attributes
ToolHandleArray< IMonitorToolBase >	m_monTools
ServiceHandle< ITHistSvc >	m_THistSvc

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Imp *	m_d
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

Detailed Description

An Algorithm that manages a set of modules, each inheriting from ManagedMonitorToolBase, by setting common configuration variables and organizing the output data.

It provides all the functionality and behaviour of AthenaMon.

Author

Michael Wilson, CERN, January 2007

Definition at line 34 of file AthenaMonManager.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

DataType_t

enum AthenaMonManager::DataType_t

An enumeration of the different types of data the monitoring application may be running over.

This can be used to select which histograms to produce, e.g., to prevent the production of colliding-beam histograms when running on cosmic-ray data. Strings of the same names may be given as jobOptions.

Enumerator
userDefined
monteCarlo
collisions
cosmics
heavyIonCollisions

Definition at line 58 of file AthenaMonManager.h.

{ userDefined = 0, monteCarlo, collisions, cosmics, heavyIonCollisions };

Environment_t

enum AthenaMonManager::Environment_t

An enumeration of the different types of running environment the monitoring application may be in.

The running environment may be used to select which histograms are produced, and where they are located in the output. For example, the output paths of the histograms are different for the "user", "online" and the various offline flags. The 'tier0Raw' and 'tier0ESD' are used to select sets of histograms for production either during the RAW --> ESD transform or during the ESD --> AOD transform (but not both!) Strings of the same names may be given as jobOptions.

Enumerator
user
noOutput
online
tier0
tier0Raw
tier0ESD
AOD
altprod

Definition at line 49 of file AthenaMonManager.h.

{ user = 0, noOutput, online, tier0, tier0Raw, tier0ESD, AOD, altprod };

Constructor & Destructor Documentation

AthenaMonManager()

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

Definition at line 191 of file AthenaMonManager.cxx.

  : AthAlgorithm( name, pSvcLocator )
  , m_monTools( this )
  , m_THistSvc("THistSvc", name)
  , m_d(new Imp(this, name))
{
    declareProperty( "AthenaMonTools", m_monTools );
    declareProperty( "CheckEveryNoEvents", m_d->m_everyNevents );
    declareProperty( "FileKey", m_d->m_fileKeyProp );
    declareProperty( "ManualDataTypeSetup", m_d->m_manualDataTypeSetupProp );
    declareProperty( "DataType", m_d->m_dataTypeProp );
    declareProperty( "Environment", m_d->m_environmentProp );
    declareProperty( "LBsInLowStatInterval", m_d->m_LBsLowStatProp );
    declareProperty( "LBsInMediumStatInterval", m_d->m_LBsMedStatProp );
    declareProperty( "LBsInHighStatInterval", m_d->m_LBsHigStatProp );
    declareProperty( "ManualRunLBSetup", m_d->m_manualRunLBProp );
    declareProperty( "Run", m_d->m_runProp );
    declareProperty( "LumiBlock", m_d->m_lumiBlockProp );
    declareProperty( "ROOTBackend", m_d->m_rootBackend );
 
    if( !Imp::s_svcLocator )
        Imp::s_svcLocator = pSvcLocator;
}

~AthenaMonManager()

AthenaMonManager::~AthenaMonManager ( )

virtual

Definition at line 217 of file AthenaMonManager.cxx.

{
    delete m_d;
 
    // If it is known that ManagedMonitorToolBase objects are deleted _after_ this object,
    // then one should call setMonManager(0) on each of them.
}

Member Function Documentation

dataType()

AthenaMonManager::DataType_t AthenaMonManager::dataType ( )

static

Returns the data type that the monitoring application is running over to help ManagedMonitorToolBase objects determine which histograms to produce.

Definition at line 311 of file AthenaMonManager.cxx.

{
    return Imp::s_dataType;
}

dataTypeStringToEnum()

AthenaMonManager::DataType_t AthenaMonManager::dataTypeStringToEnum ( const std::string & str )

static

Converts a string to a DataType_t of the same name.

Definition at line 264 of file AthenaMonManager.cxx.

{
    std::string lcstr( strToLower(str) );
 
    if( lcstr == "userdefined" )
        return userDefined;
    else if( lcstr == "montecarlo" )
        return monteCarlo;
    else if( lcstr == "collisions" )
        return collisions;
    else if( lcstr == "cosmics" )
        return cosmics;
    else if( lcstr == "heavyioncollisions" )
        return heavyIonCollisions;
 
    if( Imp::s_svcLocator ) {
        SmartIF<IMessageSvc> ms{Imp::s_svcLocator.load()->service( "MessageSvc" )};
        if( ms.isValid() ) {
            MsgStream log( ms, "AthenaMonManager::dataTypeStringToEnum()" );
            log << MSG::WARNING << "Unknown AthenaMonManager::DataType_t \""
                << str << "\", returning \"userDefined\"" << endmsg;
        }
    }
 
    return userDefined;
}

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; }

environment()

AthenaMonManager::Environment_t AthenaMonManager::environment ( )

static

Returns the running environment of the monitoring application to help ManagedMonitorToolBase objects determine which histograms to produce.

Definition at line 294 of file AthenaMonManager.cxx.

{
    return Imp::s_environment;
}

envStringToEnum()

AthenaMonManager::Environment_t AthenaMonManager::envStringToEnum ( const std::string & str )

static

Converts a string to an Environment_t of the same name.

static method (shared by all AthenaMonManager instances during run-time)

Definition at line 228 of file AthenaMonManager.cxx.

{
    std::string lcstr( strToLower(str) );
 
    if( lcstr == "user" )
        return user;
    else if( lcstr == "nooutput" )
        return noOutput;
    else if( lcstr == "online" )
        return online;
    else if( lcstr == "tier0" )
        return tier0;
    else if( lcstr == "tier0raw" )
        return tier0Raw;
    else if( lcstr == "tier0esd" )
        return tier0ESD;
    else if( lcstr == "aod" )
        return AOD;
    else if( lcstr == "altprod" )
        return altprod;
 
    if( Imp::s_svcLocator ) {
        SmartIF<IMessageSvc> ms{Imp::s_svcLocator.load()->service( "MessageSvc" )};
        if( ms.isValid() ) {
            MsgStream log( ms, "AthenaMonManager::envStringToEnum()" );
            log << MSG::WARNING << "Unknown AthenaMonManager::Environment_t \""
                << str << "\", returning \"user\"" << endmsg;
        }
    }
 
    return user;
}

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 AthenaMonManager::execute ( const EventContext & ctx )

overridevirtual

Execute method.

Implements AthAlgorithm.

Definition at line 465 of file AthenaMonManager.cxx.

{
    m_d->m_forkedProcess=false;
    pid_t currPID=getpid();
    //m_lastPID 0 means the execute method was not called yet. 
    if (m_d->m_lastPID!=0 && m_d->m_lastPID!=currPID) {
      m_d->m_forkedProcess=true;
      ATH_MSG_INFO("Forked event discovered!");
    }
    m_d->m_lastPID=currPID;
 
    Imp::HistLeakChecker lc(m_d);
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "AthenaMonManager::execute():" << endmsg;
 
    StatusCode sc;
 
    ToolHandleArray<IMonitorToolBase>::iterator monToolsEnd = m_monTools.end();
    for( ToolHandleArray<IMonitorToolBase>::iterator i = m_monTools.begin(); i != monToolsEnd; ++i ) {
        ToolHandle<IMonitorToolBase>& tool = *i;
        m_d->toolAudStart(tool);
        AthMonBench bench_tmp;
        if (m_d->m_doResourceMon)
            bench_tmp.startMeasurement();
        if( tool->preSelector() ) {
 
            sc = tool->fillHists(ctx);
 
            if( !sc.isSuccess() ) {
                if (msgLvl(MSG::WARNING)) msg(MSG::WARNING) << "IMonitorToolBase::fillHists() unsuccessful" << endmsg;
            }
        }
 
 
        if (m_d->m_doResourceMon) {
            bench_tmp.finishMeasurement();
            Imp::ToolBench* tb =  m_d->getToolBench(tool.operator->());
            tb->m_bench_algexec_fillHists += bench_tmp;//fixme: count events and subdivide
            if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "  --> m_doResourceMon is True" << endmsg;
        }
        m_d->toolAudEnd();
    }
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "  --> Done calling IMonitorToolBase::fillHists()" << endmsg;
 
    if( m_d->m_eventCounter > 0 ) {
        m_d->m_eventCounter--;
    }
    else if( m_d->m_eventCounter == 0 ) {
        for( ToolHandleArray<IMonitorToolBase>::iterator i = m_monTools.begin(); i != monToolsEnd; ++i ) {
            ToolHandle<IMonitorToolBase>& tool = *i;
            m_d->toolAudStart(tool);
            AthMonBench bench_tmp;
 
            if (m_d->m_doResourceMon)
                bench_tmp.startMeasurement();
            sc = tool->checkHists(false);
            if (m_d->m_doResourceMon) {
                bench_tmp.finishMeasurement();
                Imp::ToolBench* tb =  m_d->getToolBench(tool.operator->());
                tb->m_bench_algexec_checkHists += bench_tmp;//fixme: count events and subdivide
            }
            if( !sc.isSuccess() ) {
                if (msgLvl(MSG::WARNING)) msg(MSG::WARNING) << "IMonitorToolBase::checkHists() unsuccessful" << endmsg;
            }
            m_d->toolAudEnd();
        }
        if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "  --> Done calling IMonitorToolBase::checkHists()" << endmsg;
 
        m_d->m_eventCounter = m_d->m_everyNevents;
    }
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "  --> Exiting successfully" << endmsg;
 
    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();
}

fileKey()

std::string AthenaMonManager::fileKey ( ) const

virtual

Definition at line 626 of file AthenaMonManager.cxx.

{
    return m_d->m_fileKeyProp;
}

fillNumber()

unsigned int AthenaMonManager::fillNumber ( )

static

Definition at line 349 of file AthenaMonManager.cxx.

{
    return Imp::s_fill;
}

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();
  }

forkedProcess()

bool AthenaMonManager::forkedProcess

(

)

Definition at line 318 of file AthenaMonManager.cxx.

                {
  return m_d->m_forkedProcess;
}

getLBsHigStat()

unsigned int AthenaMonManager::getLBsHigStat ( )

static

Definition at line 306 of file AthenaMonManager.cxx.

                                             {
    return Imp::s_LBsHigStat;
}

getLBsLowStat()

unsigned int AthenaMonManager::getLBsLowStat ( )

static

Definition at line 300 of file AthenaMonManager.cxx.

                                             {
    return Imp::s_LBsLowStat;
}

getLBsMedStat()

unsigned int AthenaMonManager::getLBsMedStat ( )

static

Definition at line 303 of file AthenaMonManager.cxx.

                                             {
    return Imp::s_LBsMedStat;
}

initialize()

StatusCode AthenaMonManager::initialize ( )

overridevirtual

Definition at line 357 of file AthenaMonManager.cxx.

{
    Imp::HistLeakChecker lc(m_d);
 
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "AthenaMonManager::initialize():" << endmsg;
 
    m_d->m_sgAudSvc = Imp::s_svcLocator.load()->service("SGAudSvc", false/*do not create*/);
    m_d->m_doResourceMon = msgLvl(AthMonBench::s_resourceMonThreshold);
 
    ATH_CHECK( m_THistSvc.retrieve() );
 
    if( !Imp::s_staticDataAreInit ) {
        if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "  --> Initializing static data" << endmsg;
 
        if (msgLvl(MSG::DEBUG)) {
            msg(MSG::DEBUG) << "      * \"ManualDataTypeSetup\" = " << m_d->m_manualDataTypeSetupProp << endmsg;
        }
 
#if 0  // The two branches of the conditional are identical.
        if( m_d->m_manualDataTypeSetupProp ) {
            Imp::s_dataTypeStr = m_d->m_dataTypeProp;
            Imp::s_dataType = dataTypeStringToEnum( m_d->m_dataTypeProp );
        }
        else
#endif
        {
            Imp::s_dataTypeStr = m_d->m_dataTypeProp;
            Imp::s_dataType = dataTypeStringToEnum( m_d->m_dataTypeProp );
        }
 
        if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "      * \"DataType\" = " << Imp::s_dataType << endmsg;
 
        Imp::s_environmentStr = m_d->m_environmentProp;
        Imp::s_environment = envStringToEnum( m_d->m_environmentProp );
 
        if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "      * \"Environment\" = " << Imp::s_environment << endmsg;
 
        Imp::s_LBsLowStat = m_d->m_LBsLowStatProp;
        Imp::s_LBsMedStat = m_d->m_LBsMedStatProp;
        Imp::s_LBsHigStat = m_d->m_LBsHigStatProp;
        if (msgLvl(MSG::DEBUG)) {
            msg(MSG::DEBUG) << "      * \"LBsInLowStatInterval\" = " << Imp::s_LBsLowStat << endmsg;
            msg(MSG::DEBUG) << "      * \"LBsInMediumStatInterval\" = " << Imp::s_LBsMedStat << endmsg;
            msg(MSG::DEBUG) << "      * \"LBsInHighStatInterval\" = " << Imp::s_LBsHigStat << endmsg;
        }
 
        m_d->m_isPrimaryManager = true;
        Imp::s_staticDataAreInit = true;
 
        if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "      * \"ManualRunLBSetup\" = " << m_d->m_manualRunLBProp << endmsg;
 
        if( m_d->m_manualRunLBProp ) {
            Imp::s_run = m_d->m_runProp;
            Imp::s_lumiBlock = m_d->m_lumiBlockProp;
            Imp::s_runLBOverridden = true;
            if (msgLvl(MSG::DEBUG))
                msg(MSG::DEBUG) << "          --> using run = " << Imp::s_run << ", lumiBlock = " << Imp::s_lumiBlock << endmsg;
        } else {
            if (msgLvl(MSG::DEBUG))
                msg(MSG::DEBUG) << "          --> using run = " << Imp::s_run << ", lumiBlock = " << Imp::s_lumiBlock << endmsg;
        }
    }
 
    // Ensure consistency among all managers
    m_d->m_dataTypeProp    = Imp::s_dataTypeStr;
    m_d->m_environmentProp = Imp::s_environmentStr;
 
    // Provide a virtual Algorithm with a subset of the properties
    ServiceHandle<Gaudi::Interfaces::IOptionsSvc> joSvc("JobOptionsSvc", name());
    ATH_CHECK( joSvc.retrieve() );
    ATH_MSG_DEBUG("  --> Found service \"JobOptionsSvc\"");
 
    const std::string client = name() + std::string("Properties");
    ATH_MSG_DEBUG("  --> Adding properties under name \"" << client << "\"");
    joSvc->set( client + ".FileKey", m_d->m_fileKeyProp );
    joSvc->set( client + ".DataType", m_d->m_dataTypeProp );
    joSvc->set( client + ".Environment", m_d->m_environmentProp );
 
    if( m_monTools.size() > 0 ) {
      ATH_CHECK( m_monTools.retrieve() );
      if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "  --> Retrieved AthenaMonTools" << endmsg;
    }
 
    m_d->m_eventCounter = m_d->m_everyNevents;
 
    ToolHandleArray<IMonitorToolBase>::iterator monToolsEnd = m_monTools.end();
    for( ToolHandleArray<IMonitorToolBase>::iterator i = m_monTools.begin(); i != monToolsEnd; ++i ) {
        ToolHandle<IMonitorToolBase>& tool = *i;
        AthMonBench bench_tmp;
        IMonitorToolBase* mon = tool.operator->();
        ManagedMonitorToolBase* managed = dynamic_cast<ManagedMonitorToolBase*>( mon );
        if( managed != 0 ) {
            managed->setMonManager( this );
        }
        if (m_d->m_doResourceMon) {
            Imp::ToolBench* tb = m_d->getToolBench(mon);
            tb->m_bench_alginit_retrieve = bench_tmp;
        }
 
    }
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "  --> Exiting successfully" << endmsg;
 
    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.

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; }

lumiBlockNumber()

unsigned int AthenaMonManager::lumiBlockNumber ( )

static

Definition at line 325 of file AthenaMonManager.cxx.

{
    if (Imp::s_runLBOverridden) {
        return Imp::s_lumiBlock;
    } else {
        return Gaudi::Hive::currentContext().eventID().lumi_block();
    }
}

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.

passOwnership()

void AthenaMonManager::passOwnership ( TObject * h, const std::string & key )

virtual

Pass ownership of a TObject to this manager so that it will be deleted appropriately.

Definition at line 634 of file AthenaMonManager.cxx.

{
    m_d->m_objMap.emplace( key, h );
}

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();
  }

runNumber()

unsigned int AthenaMonManager::runNumber ( )

static

Definition at line 337 of file AthenaMonManager.cxx.

{
    if (Imp::s_runLBOverridden) {
        return Imp::s_run;
    } else {
        return Gaudi::Hive::currentContext().eventID().run_number();
    }
}

setFilterPassed()

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

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

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

start()

StatusCode AthenaMonManager::start ( )

overridevirtual

Definition at line 590 of file AthenaMonManager.cxx.

{
    Imp::HistLeakChecker lc(m_d);
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "AthenaMonManager::start():" << endmsg;
 
    StatusCode sc;
 
    ToolHandleArray<IMonitorToolBase>::iterator monToolsEnd = m_monTools.end();
    for( ToolHandleArray<IMonitorToolBase>::iterator i = m_monTools.begin(); i != monToolsEnd; ++i ) {
        ToolHandle<IMonitorToolBase>& tool = *i;
        m_d->toolAudStart(tool);
        AthMonBench bench_tmp;
        if (m_d->m_doResourceMon)
            bench_tmp.startMeasurement();
        sc = tool->bookHists();
        if (m_d->m_doResourceMon) {
            bench_tmp.finishMeasurement();
            Imp::ToolBench* tb =  m_d->getToolBench(tool.operator->());
            tb->m_bench_algexec_bookHists += bench_tmp;
        }
        if( !sc.isSuccess() ) {
            if (msgLvl(MSG::WARNING)) msg(MSG::WARNING) << "IMonitorToolBase::bookHists() unsuccessful" << endmsg;
        }
        m_d->toolAudEnd();
    }
    if (msgLvl(MSG::DEBUG)) {
        msg(MSG::DEBUG) << "  --> Done calling IMonitorToolBase::bookHists()" << endmsg;
        msg(MSG::DEBUG) << "  --> Exiting successfully" << endmsg;
    }
 
    return StatusCode::SUCCESS;
}

stop()

StatusCode AthenaMonManager::stop ( )

overridevirtual

Definition at line 542 of file AthenaMonManager.cxx.

{
    Imp::HistLeakChecker lc(m_d);
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "AthenaMonManager::finalize():" << endmsg;
 
    StatusCode sc;
 
    ToolHandleArray<IMonitorToolBase>::iterator monToolsEnd = m_monTools.end();
    for( ToolHandleArray<IMonitorToolBase>::iterator i = m_monTools.begin(); i != monToolsEnd; ++i ) {
        ToolHandle<IMonitorToolBase>& tool = *i;
        m_d->toolAudStart(tool);
 
        sc = tool->runStat();
        if( !sc.isSuccess() ) {
            if (msgLvl(MSG::WARNING)) msg(MSG::WARNING) << "IMonitorToolBase::runStat() unsuccessful" << endmsg;
        }
 
        Imp::ToolBench* tb =  m_d->m_doResourceMon ? m_d->getToolBench(tool.operator->()) : 0;
        if (tb)
            tb->m_bench_algfin_finalHists.startMeasurement();
        sc = tool->finalHists();
        if (tb)
            tb->m_bench_algfin_finalHists.finishMeasurement();
        if( !sc.isSuccess() ) {
            if (msgLvl(MSG::WARNING)) msg(MSG::WARNING) << "IMonitorToolBase::finalHists() unsuccessful" << endmsg;
        }
        if (tb)
            tb->m_bench_algfin_checkHists.startMeasurement();
        sc = tool->checkHists(true);
        if (tb)
            tb->m_bench_algfin_checkHists.finishMeasurement();
        if( !sc.isSuccess() ) {
            if (msgLvl(MSG::WARNING)) msg(MSG::WARNING) << "IMonitorToolBase::checkHists() unsuccessful" << endmsg;
        }
        if (tb)
            tb->report(this);
        m_d->toolAudEnd();
    }
    if (msgLvl(MSG::DEBUG)) {
        msg(MSG::DEBUG) << "  --> Done calling IMonitorToolBase::finalHists() and IMonitorToolBase::checkHists()" << endmsg;
        msg(MSG::DEBUG) << "  --> Exiting successfully" << endmsg;
    }
    return StatusCode::SUCCESS;
}

sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

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.

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);
      }
    }
  }

writeAndDelete()

void AthenaMonManager::writeAndDelete ( const std::string & key )

virtual

If the TObject is owned by this manager, its Write() method is called and it is deleted.

Definition at line 642 of file AthenaMonManager.cxx.

{
    // If is owned TObject, we deregister from THistSvc, write it in a
    // root file, and delete it.
 
    Imp::ObjMap_t::iterator i = m_d->m_objMap.find( key );
    if( i != m_d->m_objMap.end() ) {
        TObject* o = i->second;
        TH1* h = dynamic_cast<TH1*>( o );
        if( h != 0 ) {
            // By default, ROOT does its own bookkeeping of references to
            // histograms, and this leads to a significant amount of time
            // spent in the TObject d'tor when there are >= O(1000) TDirectories.
            // So, turn this bookkeeping off when deleting these histograms.
            bool doRecursiveReferenceDelete = gROOT->MustClean();
            gROOT->SetMustClean(false);
            TDirectory* dir = h->GetDirectory();
            TDirectory* g = gDirectory;
            if( dir )
                dir->cd();
            h->Write();
            g->cd();
 
            StatusCode sc = m_THistSvc->deReg( h );
            if( !sc.isSuccess() ) {
                if (msgLvl(MSG::WARNING)) msg(MSG::WARNING) << "AthenaMonManager::WriteAndDeleteHist(): Failure to deReg( TObject* )" << endmsg;
            }
            delete o;
            gROOT->SetMustClean(doRecursiveReferenceDelete);
            m_d->m_objMap.erase( key );
        }
    }
}

Member Data Documentation

m_d

Imp* AthenaMonManager::m_d

private

Definition at line 122 of file AthenaMonManager.h.

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_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_monTools

ToolHandleArray<IMonitorToolBase> AthenaMonManager::m_monTools

protected

Definition at line 115 of file AthenaMonManager.h.

m_THistSvc

ServiceHandle<ITHistSvc> AthenaMonManager::m_THistSvc

protected

Definition at line 117 of file AthenaMonManager.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:

• AthenaMonManager.h
• AthenaMonManager.cxx