THistSvc Class Reference

#include <src/THistSvc/THistSvc.h>

Inheritance diagram for THistSvc:

Collaboration diagram for THistSvc:

Classes
class	GlobalDirectoryRestore
	Helper class that manages ROOts global directory and file. More...
struct	THistID
	Helper struct that bundles the histogram ID with a mutex, TFile and TObject*. More...

Public Member Functions
StatusCode	initialize () override
StatusCode	reinitialize () override
StatusCode	finalize () override
void	handle (const Incident &) override
StatusCode	io_reinit () override
	callback method to reinitialize the internal state of the component for I/O purposes (e.g. More...
Functions to manage ROOT histograms of any kind
StatusCode	regHist (const std::string &name) override
	Register a new ROOT histogram TH*X with a name. More...
StatusCode	regHist (const std::string &name, std::unique_ptr< TH1 > hist) override
	Register an existing ROOT histogram TH*X with name and moved unique_ptr. More...
StatusCode	regHist (const std::string &name, std::unique_ptr< TH1 > hist, TH1 *hist_ptr) override
	Register an existing ROOT histogram TH*X with name and moved unique_ptr. More...
StatusCode	regHist (const std::string &name, TH1 *) override
StatusCode	getHist (const std::string &name, TH1 *&, size_t index=0) const override
	Return histogram with given name as TH1*, THistSvcMT still owns object. More...
StatusCode	getHist (const std::string &name, TH2 *&, size_t index=0) const override
	Return histogram with given name as TH2*, THistSvcMT still owns object. More...
StatusCode	getHist (const std::string &name, TH3 *&, size_t index=0) const override
	Return histogram with given name as TH3*, THistSvcMT still owns object. More...
Functions to manage TTrees
StatusCode	regTree (const std::string &name) override
	Register a new TTree with a given name. More...
StatusCode	regTree (const std::string &name, std::unique_ptr< TTree >) override
	Register an existing TTree with a given name and moved unique_ptr. More...
StatusCode	regTree (const std::string &name, TTree *) override
StatusCode	getTree (const std::string &name, TTree *&) const override
	Return TTree with given name. More...
Functions to manage TGraphs
StatusCode	regGraph (const std::string &name) override
	Register a new TGraph with a given name. More...
StatusCode	regGraph (const std::string &name, std::unique_ptr< TGraph >) override
	Register an existing TGraph with a given name and moved unique_ptr. More...
virtual StatusCode	regGraph (const std::string &name, TGraph *) override
StatusCode	getGraph (const std::string &name, TGraph *&) const override
	Return TGraph with given name. More...
Functions managing shared objects
StatusCode	regShared (const std::string &name, std::unique_ptr< TH1 >, LockedHandle< TH1 > &) override
	Register shared object of type TH1 and return LockedHandle for that object. More...
StatusCode	regShared (const std::string &name, std::unique_ptr< TH2 >, LockedHandle< TH2 > &) override
	Register shared object of type TH2 and return LockedHandle for that object. More...
StatusCode	regShared (const std::string &name, std::unique_ptr< TH3 >, LockedHandle< TH3 > &) override
	Register shared object of type TH3 and return LockedHandle for that object. More...
StatusCode	regShared (const std::string &name, std::unique_ptr< TGraph >, LockedHandle< TGraph > &) override
	Register shared object of type TGraph and return LockedHandle for that object. More...
StatusCode	getShared (const std::string &name, LockedHandle< TH1 > &) const override
	Retrieve shared object with given name as TH1 through LockedHandle. More...
StatusCode	getShared (const std::string &name, LockedHandle< TH2 > &) const override
	Retrieve shared object with given name as TH2 through LockedHandle. More...
StatusCode	getShared (const std::string &name, LockedHandle< TH3 > &) const override
	Retrieve shared object with given name as TH3 through LockedHandle. More...
StatusCode	getShared (const std::string &name, LockedHandle< TGraph > &) const override
	Retrieve shared object with given name as TGraph through LockedHandle. More...
Functions that work on any TObject in the THistSvcMT
StatusCode	deReg (const std::string &name) override
	Deregister object with given name and give up ownership (without deletion!) More...
StatusCode	deReg (TObject *obj) override
	Deregister obejct identified by TObject* and give up ownership (without deletion!) More...
StatusCode	merge (const std::string &id) override
	Merge all clones for object with a given id. More...
StatusCode	merge (TObject *) override
	Merge all clones for given TObject*. More...
bool	exists (const std::string &name) const override
	Check if object with given name is managed by THistSvcMT. More...
Functions returning lists of all histograms, trees and graphs
std::vector< std::string >	getHists () const override
std::vector< std::string >	getTrees () const override
std::vector< std::string >	getGraphs () const override
StatusCode	getTHists (TDirectory *td, TList &, bool recurse=false) const override
StatusCode	getTHists (const std::string &name, TList &, bool recurse=false) const override
StatusCode	getTHists (TDirectory *td, TList &tl, bool recurse=false, bool reg=false) override
StatusCode	getTHists (const std::string &name, TList &tl, bool recurse=false, bool reg=false) override
StatusCode	getTTrees (TDirectory *td, TList &, bool recurse=false) const override
StatusCode	getTTrees (const std::string &name, TList &, bool recurse=false) const override
StatusCode	getTTrees (TDirectory *td, TList &tl, bool recurse=false, bool reg=false) override
StatusCode	getTTrees (const std::string &name, TList &tl, bool recurse=false, bool reg=false) override
Public Member Functions inherited from extends< Service, ITHistSvc, IIncidentListener, IIoComponent >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...
StatusCode	configure () override
StatusCode	initialize () override
StatusCode	start () override
StatusCode	stop () override
StatusCode	finalize () override
StatusCode	terminate () override
Gaudi::StateMachine::State	FSMState () const override
Gaudi::StateMachine::State	targetFSMState () const override
StatusCode	reinitialize () override
StatusCode	restart () override
StatusCode	sysInitialize () override
	Initialize Service. More...
StatusCode	sysStart () override
	Initialize Service. More...
StatusCode	sysStop () override
	Initialize Service. More...
StatusCode	sysFinalize () override
	Finalize Service. More...
StatusCode	sysReinitialize () override
	Re-initialize the Service. More...
StatusCode	sysRestart () override
	Re-initialize the Service. More...
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...
template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const
template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...
template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...
StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...
const Gaudi::Details::PropertyBase &	getProperty (const std::string &name) const override
	get the property by name More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	convert the property to the string More...
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...
bool	hasProperty (const std::string &name) const override
	Return true if we have a property with the given name. More...
	PropertyHolder (const PropertyHolder &)=delete
PropertyHolder &	operator= (const PropertyHolder &)=delete
Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

Private Types
enum	Mode {   READ, WRITE, UPDATE, APPEND,   SHARE, INVALID }
	Enumerating all possible file access modes. More...
typedef std::recursive_mutex	THistSvcMutex_t
typedef std::mutex	histMut_t

Private Member Functions
Templated helper functions to register and retrieve Histograms and TObjects
template<typename T >
StatusCode	regHist_i (std::unique_ptr< T > hist, const std::string &name, bool shared)
template<typename T >
StatusCode	regHist_i (std::unique_ptr< T > hist, const std::string &name, bool shared, THistID *&hid)
template<typename T >
T *	getHist_i (const std::string &name, const size_t &ind=0, bool quiet=false) const
template<typename T >
T *	readHist_i (const std::string &name) const
template<typename T >
LockedHandle< T >	regShared_i (const std::string &id, std::unique_ptr< T > hist)
template<typename T >
LockedHandle< T >	getShared_i (const std::string &name) const
Collection of private helper methods
template<typename T >
T *	readHist (const std::string &name) const
TTree *	readTree (const std::string &name) const
void	updateFiles ()
	Handle case where TTree grows beyond TTree::fgMaxTreeSize. More...
StatusCode	writeObjectsToFile ()
StatusCode	connect (const std::string &)
TDirectory *	changeDir (const THistSvc::THistID &hid) const
std::string	stripDirectoryName (std::string &dir) const
void	removeDoubleSlash (std::string &) const
void	MergeRootFile (TDirectory *, TDirectory *)
bool	findStream (const std::string &name, std::string &root, std::string &rem, TFile *&file) const
void	parseString (const std::string &id, std::string &root, std::string &rem) const
void	setupInputFile ()
	call-back method to handle input stream property More...
void	setupOutputFile ()
	call-back method to handle output stream property More...
void	copyFileLayout (TDirectory *, TDirectory *)
	helper function to recursively copy the layout of a TFile into a new TFile More...
size_t	findHistID (const std::string &id, const THistID *&hid, const size_t &index=0) const
void	dump () const
StatusCode	merge (const THistID &)
	Helper method to merge THistID objects. More...
StatusCode	merge (vhid_t *)
	Helper method to merge vectors of THistID. More...
StatusCode	rootOpenAction (FILEMGR_CALLBACK_ARGS)
StatusCode	rootOpenErrAction (FILEMGR_CALLBACK_ARGS)

Static Private Member Functions
static Mode	charToMode (const char typ)
	Convert a char to a Mode enum. More...

Private Attributes
IIncidentSvc *	p_incSvc = nullptr
IFileMgr *	p_fileMgr = nullptr
bool	m_signaledStop = false
bool	m_delayConnect = false
bool	m_okToConnect = false
std::string	m_curstream
THistSvcMutex_t	m_svcMut
Gaudi properties
Gaudi::Property< int >	m_autoSave {this, "AutoSave", 0}
Gaudi::Property< int >	m_autoFlush {this, "AutoFlush", 0}
Gaudi::Property< bool >	m_print {this, "PrintAll", false}
Gaudi::Property< int >	m_maxFileSize
Gaudi::Property< int >	m_compressionLevel
Gaudi::Property< std::vector< std::string > >	m_outputfile {this, "Output", {}, &THistSvc::setupOutputFile}
Gaudi::Property< std::vector< std::string > >	m_inputfile {this, "Input", {}, &THistSvc::setupInputFile}

Container definitions
typedef std::vector< THistID >	vhid_t
typedef std::list< vhid_t * >	hlist_t
typedef std::unordered_map< std::string, vhid_t * >	uidMap_t
typedef std::unordered_multimap< std::string, vhid_t * >	idMap_t
typedef std::unordered_map< TObject *, std::pair< vhid_t *, size_t > >	objMap_t
typedef std::multimap< std::string, std::string >	streamMap
std::vector< std::string >	m_Rstream
std::vector< std::string >	m_Wstream
std::set< std::string >	m_alreadyConnectedInFiles
	list of already connected files. More...
std::set< std::string >	m_alreadyConnectedOutFiles
	list of already connected files. More...
hlist_t	m_hlist
uidMap_t	m_uids
idMap_t	m_ids
objMap_t	m_tobjs
std::map< std::string, std::pair< TFile *, Mode > >	m_files
streamMap	m_fileStreams
std::map< std::string, std::string >	m_sharedFiles

Additional Inherited Members
Public Types inherited from extends< Service, ITHistSvc, IIncidentListener, IIoComponent >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService *(const std::string &, ISvcLocator *)>
Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...
MSG::Level	resetMessaging ()
	Reinitialize internal states. More...
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, " unused"}
Gaudi::Property< bool >	m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
Gaudi::Property< bool >	m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
Gaudi::Property< bool >	m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
Gaudi::Property< bool >	m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
Gaudi::Property< bool >	m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
Gaudi::Property< bool >	m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

Definition at line 29 of file THistSvc.h.

Member Typedef Documentation

histMut_t

typedef std::mutex THistSvc::histMut_t

private

Definition at line 165 of file THistSvc.h.

hlist_t

typedef std::list<vhid_t*> THistSvc::hlist_t

private

Definition at line 251 of file THistSvc.h.

idMap_t

typedef std::unordered_multimap<std::string, vhid_t*> THistSvc::idMap_t

private

Definition at line 255 of file THistSvc.h.

objMap_t

typedef std::unordered_map<TObject*, std::pair<vhid_t*, size_t> > THistSvc::objMap_t

private

Definition at line 256 of file THistSvc.h.

streamMap

typedef std::multimap<std::string, std::string> THistSvc::streamMap

private

Definition at line 266 of file THistSvc.h.

THistSvcMutex_t

typedef std::recursive_mutex THistSvc::THistSvcMutex_t

private

Definition at line 164 of file THistSvc.h.

uidMap_t

typedef std::unordered_map<std::string, vhid_t*> THistSvc::uidMap_t

private

Definition at line 253 of file THistSvc.h.

vhid_t

typedef std::vector<THistID> THistSvc::vhid_t

private

Definition at line 249 of file THistSvc.h.

Member Enumeration Documentation

Mode

enum THistSvc::Mode

private

Enumerating all possible file access modes.

Enumerator
READ
WRITE
UPDATE
APPEND
SHARE
INVALID

Definition at line 181 of file THistSvc.h.

{ READ, WRITE, UPDATE, APPEND, SHARE, INVALID };

Member Function Documentation

changeDir()

TDirectory * THistSvc::changeDir ( const THistSvc::THistID &  hid ) const

private

Definition at line 1469 of file THistSvc.cpp.

                                                                  {
  std::string uid  = hid.id;
  TFile*      file = hid.file;
  std::string stream, fdir, bdir, dir, id;

  if ( file ) {
    file->cd( "/" );
  } else {
    gROOT->cd();
  }

  fdir = uid;
  bdir = stripDirectoryName( fdir );

  while ( ( dir = stripDirectoryName( fdir ) ) != "" ) {
    if ( !gDirectory->GetKey( dir.c_str() ) ) { gDirectory->mkdir( dir.c_str() ); }
    gDirectory->cd( dir.c_str() );
  }

  return gDirectory;
}

charToMode()

static Mode THistSvc::charToMode ( const char  typ )

inlinestaticprivate

Convert a char to a Mode enum.

Definition at line 184 of file THistSvc.h.

                                           {
    switch ( typ ) {
    case 'O':
      return READ;
    case 'A':
      return APPEND;
    case 'R':
      return UPDATE;
    case 'S':
      return SHARE;
    default:
      return INVALID;
    }
  }

connect()

StatusCode THistSvc::connect ( const std::string &  ident )

private

Definition at line 1292 of file THistSvc.cpp.

                                                     {
  auto                                        loc    = ident.find( " " );
  std::string                                 stream = ident.substr( 0, loc );
  char                                        typ( 0 );
  typedef std::pair<std::string, std::string> Prop;
  std::vector<Prop>                           props;
  std::string                                 filename, db_typ( "ROOT" );
  int                                         cl( 1 );

  if ( loc != std::string::npos ) {
    using Parser = Gaudi::Utils::AttribStringParser;
    for ( auto attrib : Parser( ident.substr( loc + 1 ) ) ) {
      auto TAG = boost::algorithm::to_upper_copy( attrib.tag );
      auto VAL = boost::algorithm::to_upper_copy( attrib.value );

      if ( TAG == "FILE" || TAG == "DATAFILE" ) {
        filename = attrib.value;
        removeDoubleSlash( filename );
      } else if ( TAG == "OPT" ) {
        if ( VAL == "APPEND" || VAL == "UPDATE" ) {
          typ = 'A';
        } else if ( VAL == "CREATE" || VAL == "NEW" || VAL == "WRITE" ) {
          typ = 'N';
        } else if ( VAL == "RECREATE" ) {
          typ = 'R';
        } else if ( VAL == "SHARE" ) {
          typ = 'S';
        } else if ( VAL == "OLD" || VAL == "READ" ) {
          typ = 'O';
        } else {
          error() << "Unknown OPT: \"" << attrib.value << "\"" << endmsg;
          typ = 0;
        }
      } else if ( TAG == "TYP" ) {
        db_typ = std::move( attrib.value );
      } else if ( TAG == "CL" ) {
        cl = std::stoi( attrib.value );
      } else {
        props.emplace_back( attrib.tag, attrib.value );
      }
    }
  }

  if ( stream == "temp" ) {
    error() << "in JobOption \"" << ident << "\": stream name \"temp\" reserved." << endmsg;
    return StatusCode::FAILURE;
  }

  if ( db_typ != "ROOT" ) {
    error() << "in JobOption \"" << ident << "\": technology type \"" << db_typ << "\" not supported." << endmsg;
    return StatusCode::FAILURE;
  }

  if ( m_files.find( stream ) != m_files.end() ) {
    error() << "in JobOption \"" << ident << "\":\n stream \"" << stream << "\" already connected to file: \""
            << m_files[stream].first->GetName() << "\"" << endmsg;
    return StatusCode::FAILURE;
  }

  const auto newMode = charToMode( typ );
  if ( newMode == THistSvc::INVALID ) {
    error() << "No OPT= specified or unknown access mode in: " << ident << endmsg;
    return StatusCode::FAILURE;
  }

  // Is this file already connected to another stream?
  if ( m_fileStreams.find( filename ) != m_fileStreams.end() ) {
    auto fitr = m_fileStreams.equal_range( filename );

    const std::string& oldstream = fitr.first->second;

    const auto& f_info = m_files[oldstream];

    if ( newMode != f_info.second ) {
      error() << "in JobOption \"" << ident << "\":\n file \"" << filename << "\" already opened by stream: \""
              << oldstream << "\" with different access mode." << endmsg;
      return StatusCode::FAILURE;
    } else {
      TFile* f2       = f_info.first;
      m_files[stream] = std::make_pair( f2, newMode );
      if ( msgLevel( MSG::DEBUG ) )
        debug() << "Connecting stream: \"" << stream << "\" to previously opened TFile: \"" << filename << "\""
                << endmsg;
      return StatusCode::SUCCESS;
    }
  }

  IIncidentSvc* pi = nullptr;
  if ( service( "IncidentSvc", pi ).isFailure() ) {
    error() << "Unable to get the IncidentSvc" << endmsg;
    return StatusCode::FAILURE;
  }

  void*  vf = nullptr;
  TFile* f  = nullptr;

  if ( newMode == THistSvc::READ ) {
    // old file
    int r = p_fileMgr->open( Io::ROOT, name(), filename, Io::READ, vf, "HIST" );

    if ( r != 0 ) {
      error() << "Unable to open ROOT file " << filename << " for reading" << endmsg;
      return StatusCode::FAILURE;
    }

    f = (TFile*)vf;

    // FIX ME!
    pi->fireIncident( FileIncident( name(), "BeginHistFile", filename ) );

  } else if ( newMode == THistSvc::WRITE ) {
    // new file. error if file exists
    int r = p_fileMgr->open( Io::ROOT, name(), filename, ( Io::WRITE | Io::CREATE | Io::EXCL ), vf, "HIST" );

    if ( r != 0 ) {
      error() << "Unable to open ROOT file " << filename << " for writing" << endmsg;
      return StatusCode::FAILURE;
    }

    f = (TFile*)vf;

  } else if ( newMode == THistSvc::APPEND ) {
    // update file
    int r = p_fileMgr->open( Io::ROOT, name(), filename, ( Io::WRITE | Io::APPEND ), vf, "HIST" );
    if ( r != 0 ) {
      error() << "unable to open file \"" << filename << "\" for appending" << endmsg;
      return StatusCode::FAILURE;
    }

    f = (TFile*)vf;

  } else if ( newMode == THistSvc::SHARE ) {
    // SHARE file type
    // For SHARE files, all data will be stored in a temp file and will be
    // merged into the target file in writeObjectsToFile() when finalize(),
    // this help to solve some confliction. e.g. with storegate
    static int  ishared      = 0;
    std::string realfilename = filename;
    filename                 = "tmp_THistSvc_" + std::to_string( ishared++ ) + ".root";

    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "Creating temp file \"" << filename << "\" and realfilename=" << realfilename << endmsg;
    }
    m_sharedFiles[stream] = realfilename;

    int r = p_fileMgr->open( Io::ROOT, name(), filename, ( Io::WRITE | Io::CREATE | Io::EXCL ), vf, "HIST" );

    if ( r != 0 ) {
      error() << "Unable to open ROOT file " << filename << " for writing" << endmsg;
      return StatusCode::FAILURE;
    }

    f = (TFile*)vf;

  } else if ( newMode == THistSvc::UPDATE ) {
    // update file
    int r = p_fileMgr->open( Io::ROOT, name(), filename, ( Io::WRITE | Io::CREATE ), vf, "HIST" );

    if ( r != 0 ) {
      error() << "Unable to open ROOT file " << filename << " for appending" << endmsg;
      return StatusCode::FAILURE;
    }

    f = (TFile*)vf;
  }

  m_files[stream] = std::make_pair( f, newMode );
  m_fileStreams.insert( std::make_pair( filename, stream ) );

  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "Opening TFile \"" << filename << "\"  stream: \"" << stream << "\"  mode: \"" << typ << "\""
            << " comp level: " << cl << endmsg;
  }

  return StatusCode::SUCCESS;
}

copyFileLayout()

void THistSvc::copyFileLayout ( TDirectory *  destination, TDirectory *  source  )

private

helper function to recursively copy the layout of a TFile into a new TFile

Definition at line 1652 of file THistSvc.cpp.

                                                                           {
  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "copyFileLayout() to destination path: " << destination->GetPath() << endmsg;
  }

  // strip out URLs
  TString path( (char*)strstr( destination->GetPath(), ":" ) );
  path.Remove( 0, 2 );

  source->cd( path );
  TDirectory* current_source_dir = gDirectory;

  // loop over all keys in this directory
  TList* key_list = current_source_dir->GetListOfKeys();
  int    n        = key_list->GetEntries();
  for ( int j = 0; j < n; ++j ) {
    TKey*             k               = (TKey*)key_list->At( j );
    const std::string source_pathname = current_source_dir->GetPath() + std::string( "/" ) + k->GetName();
    TObject*          o               = source->Get( source_pathname.c_str() );

    if ( o && o->IsA()->InheritsFrom( "TDirectory" ) ) {
      if ( msgLevel( MSG::VERBOSE ) ) { verbose() << " subdir [" << o->GetName() << "]..." << endmsg; }
      destination->cd();
      // Create directory if it does not exist yet
      TDirectory* destination_dir = destination->mkdir( o->GetName(), o->GetTitle() );
      if ( destination_dir == nullptr ) destination_dir = destination->GetDirectory( o->GetName() );
      copyFileLayout( destination_dir, source );
    }
  } // loop over keys
  return;
}

deReg() [1/2]

StatusCode THistSvc::deReg ( const std::string &  name )

override

Deregister object with given name and give up ownership (without deletion!)

Definition at line 514 of file THistSvc.cpp.

                                                {
  auto itr = m_uids.find( id );
  if ( itr == m_uids.end() ) {
    error() << "Problem deregistering id \"" << id << "\": not found in registry" << endmsg;
    return StatusCode::FAILURE;
  }

  vhid_t* vh = itr->second;
  debug() << "will deregister " << vh->size() << " elements of id \"" << id << "\"" << endmsg;
  StatusCode sc( StatusCode::SUCCESS );
  // vh will get deleted in deReg once empty, so we cannot query the list size in the loop
  size_t vh_size = vh->size();
  while ( vh_size-- ) {
    if ( deReg( vh->back().obj ).isFailure() ) {
      sc = StatusCode::FAILURE;
      error() << "Problems deRegistering " << vh->size() << " element of id \"" << id << "\"" << endmsg;
      break;
    }
  }

  return sc;
}

deReg() [2/2]

StatusCode THistSvc::deReg ( TObject *  obj )

override

Deregister obejct identified by TObject* and give up ownership (without deletion!)

Definition at line 537 of file THistSvc.cpp.

                                         {
  objMap_t::iterator obj_itr = m_tobjs.find( obj );
  if ( obj_itr != m_tobjs.end() ) {
    vhid_t* vhid = obj_itr->second.first;
    THistID hid  = obj_itr->second.first->at( obj_itr->second.second );

    auto uid_itr = m_uids.find( hid.id );
    if ( uid_itr == m_uids.end() ) {
      error() << "Problems deregistering TObject \"" << obj->GetName() << "\" with id \"" << hid.id
              << "\": not in uidMap" << endmsg;
      return StatusCode::FAILURE;
    }

    if ( vhid->size() == 1 ) {
      // We are the last object, so we have to delete vhid properly
      debug() << "vhid for " << hid.id << " is empty. deleting" << endmsg;

      std::string root, rem;
      parseString( hid.id, root, rem );

      auto mitr   = m_ids.equal_range( rem );
      auto id_itr = std::find_if( mitr.first, mitr.second,
                                  [&]( idMap_t::const_reference i ) { return i.second->at( 0 ).obj == obj; } );
      if ( id_itr == mitr.second ) {
        error() << "Problems deregistering TObject \"" << obj->GetName() << "\" with id \"" << hid.id
                << "\": not in idMap" << endmsg;
        return StatusCode::FAILURE;
      }

      auto hlist_itr = std::find( m_hlist.begin(), m_hlist.end(), vhid );
      if ( hlist_itr == m_hlist.end() ) {
        error() << "Problems deregistering TObject \"" << obj->GetName() << "\" with id \"" << hid.id
                << "\": not in hlist" << endmsg;
        return StatusCode::FAILURE;
      }

      vhid->erase( vhid->begin() + obj_itr->second.second );
      m_tobjs.erase( obj_itr );

      m_uids.erase( uid_itr );
      m_ids.erase( id_itr );
      m_hlist.erase( hlist_itr );

      delete vhid;

    } else if ( vhid->size() > 1 ) {
      m_tobjs.erase( obj_itr );
      vhid->erase( vhid->begin() + obj_itr->second.second );

      // vector of THistID is still not empty (i.e. other instances with same name registered)
    } else {
      error() << "Deregistration failed unexpectedly. (bug in THistSvc?)" << endmsg;
    }
    return StatusCode::SUCCESS;
  } else {
    error() << "Cannot unregister TObject \"" << obj->GetName() << "\": not known to THistSvc" << endmsg;
    return StatusCode::FAILURE;
  }
}

dump()

void THistSvc::dump ( ) const

private

Definition at line 1729 of file THistSvc.cpp.

                          {
  std::ostringstream ost;

  // list< vector<THistID> >
  ost << "m_hlist:  size: " << m_hlist.size() << "\n";
  for ( auto& vh : m_hlist ) {
    ost << " - " << vh->at( 0 ) << " :: [" << vh << "] " << vh->size() << " {";
    for ( auto& e : *vh ) {
      TObject* o = e.obj;
      ost << "[" << o << "]";
    }
    ost << "}\n";
  }

  // map uid -> vector<THistID>*
  ost << "\n"
      << "m_uids: " << m_uids.size() << "\n";
  for ( auto& e : m_uids ) { ost << " - " << e.first << "  [" << e.second << "]" << std::endl; }

  // multimap id -> vector<THistID>*
  ost << "\n"
      << "m_ids: " << m_ids.size() << "\n";
  for ( auto& e : m_ids ) { ost << " - " << e.first << "  [" << e.second << "]" << std::endl; }

  // map TObject* -> THistID*
  ost << "\n"
      << "m_tobjs: " << m_tobjs.size() << "\n";
  for ( auto& e : m_tobjs ) {
    TObject* o = e.first;
    THistID& i = e.second.first->at( e.second.second );
    ost << " - " << o << " -> " << i << std::endl;
  }

  debug() << "dumping THistSvc contents\n" << ost.str() << endmsg;
}

exists()

bool THistSvc::exists ( const std::string &  name ) const

override

Check if object with given name is managed by THistSvcMT.

Definition at line 617 of file THistSvc.cpp.

{ return ( getHist_i<TH1>( name, 0, true ) != nullptr ); }

finalize()

StatusCode THistSvc::finalize ( )

override

Definition at line 179 of file THistSvc.cpp.

                              {
  GlobalDirectoryRestore restore( m_svcMut );

  if ( msgLevel( MSG::DEBUG ) ) {
    dump();
    debug() << "THistSvc::finalize" << endmsg;
  }

#ifndef NDEBUG
  if ( msgLevel( MSG::DEBUG ) ) {
    const std::map<uidMap_t::key_type, uidMap_t::mapped_type> sorted_uids{begin( m_uids ), end( m_uids )};
    for ( const auto& itr : sorted_uids ) {
      THistID& thid = itr.second->at( 0 );
      TObject* tobj = thid.obj;

      std::string dirname( "none" );
      if ( tobj && tobj->IsA()->InheritsFrom( "TTree" ) ) {
        TTree* tree = dynamic_cast<TTree*>( tobj );
        if ( tree->GetDirectory() != 0 ) { dirname = tree->GetDirectory()->GetPath(); }
      } else if ( tobj && tobj->IsA()->InheritsFrom( "TGraph" ) ) {
        if ( !thid.temp ) {
          dirname = thid.file->GetPath();
          std::string id2( thid.id );
          id2.erase( 0, id2.find( "/", 1 ) );
          id2.erase( id2.rfind( "/" ), id2.length() );
          if ( id2.find( "/" ) == 0 ) { id2.erase( 0, 1 ); }
          dirname += id2;
        } else {
          dirname = "/tmp";
        }
      } else if ( tobj && tobj->IsA()->InheritsFrom( "TH1" ) ) {
        TH1* th = dynamic_cast<TH1*>( tobj );
        if ( th == nullptr ) {
          error() << "Couldn't dcast: " << itr.first << endmsg;
        } else {
          if ( th->GetDirectory() != 0 ) { dirname = th->GetDirectory()->GetPath(); }
        }
      } else if ( !tobj ) {
        warning() << itr.first << " has NULL TObject ptr" << endmsg;
      }
      debug() << "finalize: " << thid << endmsg;
    }
  }
#endif

  if ( writeObjectsToFile().isFailure() ) { error() << "problems writing histograms" << endmsg; }

  if ( m_print ) { info() << "Listing contents of ROOT files: " << endmsg; }
  std::vector<TFile*> deleted_files;
  for ( auto& itr : m_files ) {
    if ( std::find( deleted_files.begin(), deleted_files.end(), itr.second.first ) == deleted_files.end() ) {
      deleted_files.push_back( itr.second.first );

#ifndef NDEBUG
      if ( msgLevel( MSG::DEBUG ) ) {
        debug() << "finalizing stream/file " << itr.first << ":" << itr.second.first->GetName() << endmsg;
      }
#endif
    } else {
#ifndef NDEBUG
      if ( msgLevel( MSG::DEBUG ) ) { debug() << "already finalized stream " << itr.first << endmsg; }
#endif
      continue;
    }

    if ( m_print && msgLevel( MSG::INFO ) ) {
      info() << "==> File: " << itr.second.first->GetName() << "  stream: " << itr.first << endmsg;

      itr.second.first->Print( "base" );
    }

    std::string tmpfn = itr.second.first->GetName();

    p_fileMgr->close( itr.second.first, name() );

    IIncidentSvc* pIncidentSvc = nullptr;
    if ( service( "IncidentSvc", pIncidentSvc ).isFailure() ) {
      error() << "Unable to get the IncidentSvc" << endmsg;
      return StatusCode::FAILURE;
    }

    if ( itr.second.second == SHARE ) {
      // Merge File
      void* vfile = nullptr;
      int   returncode =
          p_fileMgr->open( Io::ROOT, name(), m_sharedFiles[itr.first], Io::WRITE | Io::APPEND, vfile, "HIST" );

      if ( returncode ) {
        error() << "unable to open Final Output File: \"" << m_sharedFiles[itr.first] << "\" for merging" << endmsg;
        return StatusCode::FAILURE;
      }

      TFile* outputfile = (TFile*)vfile;
      pIncidentSvc->fireIncident( FileIncident( name(), IncidentType::WroteToOutputFile, m_sharedFiles[itr.first] ) );

      if ( msgLevel( MSG::DEBUG ) ) { debug() << "THistSvc::writeObjectsToFile()::Merging Rootfile " << endmsg; }

      vfile      = nullptr;
      returncode = p_fileMgr->open( Io::ROOT, name(), tmpfn, Io::READ, vfile, "HIST" );

      if ( returncode ) {
        error() << "unable to open temporary file: \"" << tmpfn << endmsg;
        return StatusCode::FAILURE;
      }

      TFile* inputfile = (TFile*)vfile;

      outputfile->SetCompressionLevel( inputfile->GetCompressionLevel() );

      MergeRootFile( outputfile, inputfile );

      outputfile->Write();
      p_fileMgr->close( outputfile, name() );
      p_fileMgr->close( inputfile, name() );

      if ( msgLevel( MSG::DEBUG ) ) { debug() << "Trying to remove temporary file \"" << tmpfn << "\"" << endmsg; }

      std::remove( tmpfn.c_str() );
    }
    delete itr.second.first;
  }

  m_files.clear();
  m_sharedFiles.clear();
  m_fileStreams.clear();
  m_hlist.clear(); // vhid* is deleted in m_tobjs
  m_uids.clear();  // vhid* is deleted in m_tobjs
  m_ids.clear();   // vhid* is deleted in m_tobjs

  for ( auto& obj : m_tobjs ) {
    // TObject*'s are already dealt with through root file i/o
    delete obj.second.first; // delete vhid*
  }
  m_tobjs.clear();

  return Service::finalize();
}

findHistID()

size_t THistSvc::findHistID ( const std::string &  id, const THistID *&  hid, const size_t &  index = 0  ) const

private

Definition at line 1684 of file THistSvc.cpp.

                                                                                                 {
  GlobalDirectoryRestore restore( m_svcMut );

  std::string idr( id );
  removeDoubleSlash( idr );

  hid = 0;

  if ( idr.find( "/" ) == 0 ) {
    // fully specified name, starts with "/"
    auto itr = m_uids.find( idr );
    if ( itr == m_uids.end() ) {
      // no matches found
      return 0;
    } else {
      // one or more matches found (clones).
      if ( index >= itr->second->size() ) {
        error() << "no index " << index << " found for Hist " << idr << endmsg;
        return 0;
      }
      hid = &( itr->second->at( index ) );
      return 1;
    }
  } else {
    // name not fully specified.
    auto mitr = m_ids.equal_range( idr );
    if ( mitr.first == mitr.second ) {
      // not found
      return 0;
    } else if ( distance( mitr.first, mitr.second ) == 1 ) {
      // one found
      if ( index >= mitr.first->second->size() ) {
        error() << "no index " << index << " found for Hist " << idr << endmsg;
        return 0;
      }
      hid = &( mitr.first->second->at( 0 ) );
      return 1;
    } else {
      // multiple matches
      hid = &( mitr.first->second->at( 0 ) );
      return distance( mitr.first, mitr.second );
    }
  }
}

findStream()

bool THistSvc::findStream ( const std::string &  name, std::string &  root, std::string &  rem, TFile *&  file  ) const

private

Definition at line 1558 of file THistSvc.cpp.

                                                                                                      {
  auto pos = id.find( "/" );

  if ( pos == std::string::npos ) {
    // no "/" in id
    stream = "temp";
    rem    = id;
  } else if ( pos != 0 ) {
    // id does not start with "/"
    stream = "temp";
    rem    = id;
  } else {
    // id starts with "/"

    auto pos2 = id.find( "/", pos + 1 );

    if ( pos2 == std::string::npos ) {
      // need at least 2 "/" in format "/STREAM/name" or "/STREAM/dir/name"
      error() << "badly formed Hist/Tree id: \"" << id << "\"" << endmsg;
      return false;
    }
    parseString( id, stream, rem );
  }

  if ( stream == "temp" ) {
    file = nullptr;
    return true;
  }

  auto itr = m_files.find( stream );
  file     = ( itr != m_files.end() ? itr->second.first : nullptr );
  if ( !file ) { warning() << "no stream \"" << stream << "\" associated with id: \"" << id << "\"" << endmsg; }

  return true;
}

getGraph()

StatusCode THistSvc::getGraph ( const std::string &  name, TGraph *&  graph  ) const

override

Return TGraph with given name.

Definition at line 433 of file THistSvc.cpp.

                                                                         {
  graph = getHist_i<TGraph>( id );
  if ( graph != nullptr ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getGraphs()

std::vector< std::string > THistSvc::getGraphs ( ) const

override

Definition at line 635 of file THistSvc.cpp.

                                               {
  std::vector<std::string> names;
  names.reserve( m_uids.size() );
  transform_if( std::begin( m_uids ), std::end( m_uids ), std::back_inserter( names ), select1st,
                []( uidMap_t::const_reference i ) { return i.second->at( 0 ).obj->IsA()->InheritsFrom( "TGraph" ); } );
  return names;
}

getHist() [1/3]

StatusCode THistSvc::getHist ( const std::string &  name, TH1 *&  hist, size_t  index = 0  ) const

override

Return histogram with given name as TH1*, THistSvcMT still owns object.

Definition at line 339 of file THistSvc.cpp.

                                                                                {
  hist = getHist_i<TH1>( id, ind );
  if ( hist != nullptr ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getHist() [2/3]

StatusCode THistSvc::getHist ( const std::string &  name, TH2 *&  hist, size_t  index = 0  ) const

override

Return histogram with given name as TH2*, THistSvcMT still owns object.

Definition at line 348 of file THistSvc.cpp.

                                                                                {
  hist = getHist_i<TH2>( id, ind );
  if ( hist != nullptr ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getHist() [3/3]

StatusCode THistSvc::getHist ( const std::string &  name, TH3 *&  hist, size_t  index = 0  ) const

override

Return histogram with given name as TH3*, THistSvcMT still owns object.

Definition at line 357 of file THistSvc.cpp.

                                                                                {
  hist = getHist_i<TH3>( id, ind );
  if ( hist != nullptr ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getHist_i()

template<typename T >

T * THistSvc::getHist_i ( const std::string &  name, const size_t &  ind = 0, bool  quiet = false  ) const

private

Definition at line 164 of file THistSvc.icc.

                                                                                 {
  // id starts with "/": unique

  GlobalDirectoryRestore restore( m_svcMut );

  T*             hist = nullptr;
  const THistID* hid  = nullptr;
  size_t         num  = findHistID( id, hid, ind );
  if ( num == 0 ) {
    // no matches found
    if ( !quiet ) { error() << "could not locate Hist with id \"" << id << "\"" << endmsg; }
    return nullptr;
  } else if ( num > 1 ) {
    if ( !quiet ) {
      // return failure if trying to GET a single hist
      error() << "Multiple matches with id \"" << id << "\"."
              << " Further specifications required." << endmsg;
      return nullptr;
    } else {
      info() << "Found multiple matches with id \"" << id << "\"" << endmsg;
      // return first match if just INQUIRING (i.e. != nullptr)
      hist = dynamic_cast<T*>( hid->obj );
      if ( hist == nullptr ) {
        error() << "dcast failed, Hist id: \"" << id << "\"" << endmsg;
        return nullptr;
      }
    }
  } else {
    hist = dynamic_cast<T*>( hid->obj );
    if ( hist == nullptr ) {
      error() << "dcast failed, Hist id: \"" << id << "\"" << endmsg;
      return nullptr;
    }
    verbose() << "found unique Hist title: \"" << hist->GetTitle() << "\"  id: \"" << id << "\"" << endmsg;
  }

  return hist;
}

getHists()

std::vector< std::string > THistSvc::getHists ( ) const

override

Definition at line 619 of file THistSvc.cpp.

                                              {
  std::vector<std::string> names;
  names.reserve( m_uids.size() );
  transform_if( std::begin( m_uids ), std::end( m_uids ), std::back_inserter( names ), select1st,
                []( uidMap_t::const_reference i ) { return i.second->at( 0 ).obj->IsA()->InheritsFrom( "TH1" ); } );
  return names;
}

getShared() [1/4]

StatusCode THistSvc::getShared ( const std::string &  name, LockedHandle< TH1 > &  lh  ) const

override

Retrieve shared object with given name as TH1 through LockedHandle.

Definition at line 478 of file THistSvc.cpp.

                                                                                   {
  lh = getShared_i<TH1>( name );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getShared() [2/4]

StatusCode THistSvc::getShared ( const std::string &  name, LockedHandle< TH2 > &  lh  ) const

override

Retrieve shared object with given name as TH2 through LockedHandle.

Definition at line 487 of file THistSvc.cpp.

                                                                                   {
  lh = getShared_i<TH2>( name );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getShared() [3/4]

StatusCode THistSvc::getShared ( const std::string &  name, LockedHandle< TH3 > &  lh  ) const

override

Retrieve shared object with given name as TH3 through LockedHandle.

Definition at line 496 of file THistSvc.cpp.

                                                                                   {
  lh = getShared_i<TH3>( name );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getShared() [4/4]

StatusCode THistSvc::getShared ( const std::string &  name, LockedHandle< TGraph > &  lh  ) const

override

Retrieve shared object with given name as TGraph through LockedHandle.

Definition at line 505 of file THistSvc.cpp.

                                                                                      {
  lh = getShared_i<TGraph>( name );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getShared_i()

template<typename T >

LockedHandle< T > THistSvc::getShared_i ( const std::string &  name ) const

private

Definition at line 292 of file THistSvc.icc.

                                                                   {
  GlobalDirectoryRestore restore( m_svcMut );

  const THistID* hid = nullptr;
  size_t         i   = findHistID( name, hid );

  LockedHandle<T> hist( nullptr, nullptr );

  if ( i == 1 ) {
    if ( !hid->shared ) {
      error() << "getSharedHist: found Hist with id \"" << name << "\", but it's not marked as shared" << endmsg;
      return hist;
    }
    T* h1 = dynamic_cast<T*>( hid->obj );
    hist  = LockedHandle<T>( h1, hid->mutex );

    debug() << "getSharedHist: found THistID: " << *hid << endmsg;
  } else if ( i == 0 ) {
    error() << "no histograms matching id \"" << name << "\" found" << endmsg;
  } else {
    info() << "multiple matches for id \"" << name << "\" found [" << i << "], probably from different streams"
           << endmsg;
  }
  return hist;
}

getTHists() [1/4]

StatusCode THistSvc::getTHists ( TDirectory *  td, TList &  tl, bool  recurse = false  ) const

override

Definition at line 643 of file THistSvc.cpp.

                                                                          {
  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  if ( !td->cd() ) {
    error() << "getTHists: No such TDirectory \"" << td->GetPath() << "\"" << endmsg;
    return StatusCode::FAILURE;
  }

  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "getTHists: \"" << td->GetPath() << "\": found " << td->GetListOfKeys()->GetSize() << " keys" << endmsg;
  }

  TIter nextkey( td->GetListOfKeys() );
  while ( TKey* key = (TKey*)nextkey() ) {
    auto& log = debug();
    if ( msgLevel( MSG::DEBUG ) ) log << "  key: " << key->GetName();
    TObject* obj = key->ReadObj();
    if ( obj != 0 && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
    } else if ( obj != 0 && obj->IsA()->InheritsFrom( "TH1" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
      tl.Add( obj );
    } else if ( obj != 0 ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " [" << obj->IsA()->GetName() << "]";
    }
    if ( msgLevel( MSG::DEBUG ) ) log << endmsg;
  }

  // operate recursively
  if ( rcs ) {
    nextkey = td->GetListOfKeys();
    while ( TKey* key = (TKey*)nextkey() ) {
      TObject* obj = key->ReadObj();
      if ( obj && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
        TDirectory* tt = dynamic_cast<TDirectory*>( obj );
        getTHists( tt, tl, rcs );
      }
    }
  }

  return StatusCode::SUCCESS;
}

getTHists() [2/4]

StatusCode THistSvc::getTHists ( const std::string &  name, TList &  tl, bool  recurse = false  ) const

override

Definition at line 688 of file THistSvc.cpp.

                                                                                {

  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  StatusCode sc;

  std::string stream, rem, r2;
  parseString( dir, stream, rem );

  auto itr = m_files.find( stream );
  if ( itr != m_files.end() ) {
    r2 = itr->second.first->GetName();
    r2 += ":/";
    r2 += rem;

    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "getTHists: \"" << dir << "\" looks like a stream name."
              << " associated TFile: \"" << itr->second.first->GetName() << "\"" << endmsg;
    }

    if ( gDirectory->cd( r2.c_str() ) ) {
      m_curstream = stream;
      sc          = getTHists( gDirectory, tl, rcs );
      m_curstream = "";
      return sc;
    } else {
      if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTHists: no such TDirectory \"" << r2 << "\"" << endmsg; }
    }

  } else {
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTHists: stream \"" << stream << "\" not found" << endmsg; }
  }

  if ( !gDirectory->cd( dir.c_str() ) ) {
    error() << "getTHists: No such TDirectory/stream \"" << dir << "\"" << endmsg;
    sc = StatusCode::FAILURE;
  } else {
    sc = getTHists( gDirectory, tl, rcs );
  }

  return sc;
}

getTHists() [3/4]

StatusCode THistSvc::getTHists ( TDirectory *  td, TList &  tl, bool  recurse = false, bool  reg = false  )

override

Definition at line 733 of file THistSvc.cpp.

                                                                              {
  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  if ( !td->cd() ) {
    error() << "getTHists: No such TDirectory \"" << td->GetPath() << "\"" << endmsg;
    return StatusCode::FAILURE;
  }

  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "getTHists: \"" << td->GetPath() << "\": found " << td->GetListOfKeys()->GetSize() << " keys" << endmsg;
  }

  TIter nextkey( td->GetListOfKeys() );
  while ( TKey* key = (TKey*)nextkey() ) {
    auto& log = debug();
    if ( msgLevel( MSG::DEBUG ) ) log << "  key: " << key->GetName();
    TObject* obj = key->ReadObj();
    if ( obj && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
    } else if ( obj && obj->IsA()->InheritsFrom( "TH1" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
      tl.Add( obj );
      if ( reg && m_curstream != "" ) {
        std::string dir = td->GetPath();
        std::string fil = td->GetFile()->GetName();
        dir.erase( 0, fil.length() + 1 );
        std::string id = "/" + m_curstream;
        if ( dir == "/" ) {
          id = id + "/" + key->GetName();
        } else {
          id = id + dir + "/" + key->GetName();
        }
        if ( !exists( id ) ) {
          if ( msgLevel( MSG::DEBUG ) ) log << "  reg as \"" << id << "\"";
          regHist( id ).ignore();
        } else {
          if ( msgLevel( MSG::DEBUG ) ) log << "  already registered";
        }
      }
    } else if ( obj ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " [" << obj->IsA()->GetName() << "]";
    }
    if ( msgLevel( MSG::DEBUG ) ) log << endmsg;
  }

  // operate recursively
  if ( rcs ) {
    nextkey = td->GetListOfKeys();
    while ( TKey* key = (TKey*)nextkey() ) {
      TObject* obj = key->ReadObj();
      if ( obj && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
        TDirectory* tt = dynamic_cast<TDirectory*>( obj );
        getTHists( tt, tl, rcs, reg );
      }
    }
  }

  return StatusCode::SUCCESS;
}

getTHists() [4/4]

StatusCode THistSvc::getTHists ( const std::string &  name, TList &  tl, bool  recurse = false, bool  reg = false  )

override

Definition at line 795 of file THistSvc.cpp.

                                                                                    {
  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  StatusCode sc;

  std::string stream, rem, r2;
  parseString( dir, stream, rem );

  auto itr = m_files.find( stream );
  if ( itr != m_files.end() ) {
    r2 = itr->second.first->GetName();
    r2 += ":/";
    r2 += rem;

    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "getTHists: \"" << dir << "\" looks like a stream name."
              << " associated TFile: \"" << itr->second.first->GetName() << "\"" << endmsg;
    }

    if ( gDirectory->cd( r2.c_str() ) ) {
      m_curstream = stream;
      sc          = getTHists( gDirectory, tl, rcs, reg );
      m_curstream.clear();
      return sc;
    }
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTHists: no such TDirectory \"" << r2 << "\"" << endmsg; }
  } else {
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTHists: stream \"" << stream << "\" not found" << endmsg; }
  }

  if ( !gDirectory->cd( dir.c_str() ) ) {
    error() << "getTHists: No such TDirectory/stream \"" << dir << "\"" << endmsg;
    sc = StatusCode::FAILURE;
  } else {
    if ( reg ) {
      warning() << "Unable to register histograms automatically "
                << "without a valid stream name" << endmsg;
      reg = false;
    }
    sc = getTHists( gDirectory, tl, rcs, reg );
  }

  return sc;
}

getTree()

StatusCode THistSvc::getTree ( const std::string &  name, TTree *&  tree  ) const

override

Return TTree with given name.

Definition at line 392 of file THistSvc.cpp.

                                                                      {
  tree = getHist_i<TTree>( id );
  if ( tree != nullptr ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

getTrees()

std::vector< std::string > THistSvc::getTrees ( ) const

override

Definition at line 627 of file THistSvc.cpp.

                                              {
  std::vector<std::string> names;
  names.reserve( m_uids.size() );
  transform_if( std::begin( m_uids ), std::end( m_uids ), std::back_inserter( names ), select1st,
                []( uidMap_t::const_reference i ) { return i.second->at( 0 ).obj->IsA()->InheritsFrom( "TTree" ); } );
  return names;
}

getTTrees() [1/4]

StatusCode THistSvc::getTTrees ( TDirectory *  td, TList &  tl, bool  recurse = false  ) const

override

Definition at line 842 of file THistSvc.cpp.

                                                                          {
  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  if ( !td->cd() ) {
    error() << "getTTrees: No such TDirectory \"" << td->GetPath() << "\"" << endmsg;
    return StatusCode::FAILURE;
  }

  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "getTHists: \"" << td->GetPath() << "\": found " << td->GetListOfKeys()->GetSize() << " keys" << endmsg;
  }

  TIter nextkey( td->GetListOfKeys() );
  while ( TKey* key = (TKey*)nextkey() ) {
    auto& log = debug();
    if ( msgLevel( MSG::DEBUG ) ) log << "  key: " << key->GetName();
    TObject* obj = key->ReadObj();
    if ( obj != 0 && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
    } else if ( obj != 0 && obj->IsA()->InheritsFrom( "TTree" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
      tl.Add( obj );
    } else if ( obj != 0 ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " [" << obj->IsA()->GetName() << "]";
    }
    log << endmsg;
  }

  // operate recursively
  if ( rcs ) {
    nextkey = td->GetListOfKeys();
    while ( TKey* key = (TKey*)nextkey() ) {
      TObject* obj = key->ReadObj();
      if ( obj && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
        TDirectory* tt = dynamic_cast<TDirectory*>( obj );
        getTTrees( tt, tl, rcs );
      }
    }
  }

  return StatusCode::SUCCESS;
}

getTTrees() [2/4]

StatusCode THistSvc::getTTrees ( const std::string &  name, TList &  tl, bool  recurse = false  ) const

override

Definition at line 887 of file THistSvc.cpp.

                                                                                {
  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  StatusCode sc;

  std::string stream, rem, r2;
  parseString( dir, stream, rem );

  auto itr = m_files.find( stream );
  if ( itr != m_files.end() ) {
    r2 = itr->second.first->GetName();
    r2 += ":/";
    r2 += rem;

    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "getTTrees: \"" << dir << "\" looks like a stream name."
              << " associated TFile: \"" << itr->second.first->GetName() << "\"" << endmsg;
    }

    if ( gDirectory->cd( r2.c_str() ) ) { return getTTrees( gDirectory, tl, rcs ); }
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTTrees: no such TDirectory \"" << r2 << "\"" << endmsg; }
  } else {
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTTrees: stream \"" << stream << "\" not found" << endmsg; }
  }

  if ( !gDirectory->cd( dir.c_str() ) ) {
    error() << "getTTrees: No such TDirectory/stream \"" << dir << "\"" << endmsg;
    sc = StatusCode::FAILURE;
  } else {
    sc = getTTrees( gDirectory, tl, rcs );
  }
  return sc;
}

getTTrees() [3/4]

StatusCode THistSvc::getTTrees ( TDirectory *  td, TList &  tl, bool  recurse = false, bool  reg = false  )

override

Definition at line 923 of file THistSvc.cpp.

                                                                              {
  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  if ( !td->cd() ) {
    error() << "getTTrees: No such TDirectory \"" << td->GetPath() << "\"" << endmsg;
    return StatusCode::FAILURE;
  }

  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "getTHists: \"" << td->GetPath() << "\": found " << td->GetListOfKeys()->GetSize() << " keys" << endmsg;
  }

  TIter nextkey( td->GetListOfKeys() );
  while ( TKey* key = (TKey*)nextkey() ) {
    auto& log = debug();
    if ( msgLevel( MSG::DEBUG ) ) log << "  key: " << key->GetName();
    TObject* obj = key->ReadObj();
    if ( obj && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
    } else if ( obj && obj->IsA()->InheritsFrom( "TTree" ) ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " (" << obj->IsA()->GetName() << ")";
      tl.Add( obj );
      if ( reg && m_curstream != "" ) {
        std::string dir = td->GetPath();
        std::string fil = td->GetFile()->GetName();
        dir.erase( 0, fil.length() + 1 );
        std::string id = "/" + m_curstream;
        if ( dir == "/" ) {
          id = id + "/" + key->GetName();
        } else {
          id = id + dir + "/" + key->GetName();
        }
        if ( !exists( id ) ) {
          if ( msgLevel( MSG::DEBUG ) ) log << "  reg as \"" << id << "\"";
          regHist( id ).ignore();
        } else {
          if ( msgLevel( MSG::DEBUG ) ) log << "  already registered";
        }
      }
    } else if ( obj != 0 ) {
      if ( msgLevel( MSG::DEBUG ) ) log << " [" << obj->IsA()->GetName() << "]";
    }
    if ( msgLevel( MSG::DEBUG ) ) log << endmsg;
  }

  // operate recursively
  if ( rcs ) {
    nextkey = td->GetListOfKeys();
    while ( TKey* key = (TKey*)nextkey() ) {
      TObject* obj = key->ReadObj();
      if ( obj && obj->IsA()->InheritsFrom( "TDirectory" ) ) {
        TDirectory* tt = dynamic_cast<TDirectory*>( obj );
        getTTrees( tt, tl, rcs, reg );
      }
    }
  }

  return StatusCode::SUCCESS;
}

getTTrees() [4/4]

StatusCode THistSvc::getTTrees ( const std::string &  name, TList &  tl, bool  recurse = false, bool  reg = false  )

override

Definition at line 985 of file THistSvc.cpp.

                                                                                    {
  GlobalDirectoryRestore restore( m_svcMut );

  gErrorIgnoreLevel = kBreak;

  StatusCode sc;

  std::string stream, rem, r2;
  parseString( dir, stream, rem );

  auto itr = m_files.find( stream );
  if ( itr != m_files.end() ) {
    r2 = itr->second.first->GetName();
    r2 += ":/";
    r2 += rem;

    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "getTTrees: \"" << dir << "\" looks like a stream name."
              << " associated TFile: \"" << itr->second.first->GetName() << "\"" << endmsg;
    }

    if ( gDirectory->cd( r2.c_str() ) ) {
      return getTTrees( gDirectory, tl, rcs, reg );
    } else {
      if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTTrees: no such TDirectory \"" << r2 << "\"" << endmsg; }
    }
  } else {
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "getTTrees: stream \"" << stream << "\" not found" << endmsg; }
  }

  if ( !gDirectory->cd( dir.c_str() ) ) {
    error() << "getTTrees: No such TDirectory/stream \"" << dir << "\"" << endmsg;
    return StatusCode::FAILURE;
  }

  return getTTrees( gDirectory, tl, rcs, reg );
}

handle()

void THistSvc::handle ( const Incident &  )

override

Definition at line 1025 of file THistSvc.cpp.

                                         {
  if ( m_signaledStop ) return;

  if ( m_maxFileSize.value() == -1 ) return;

  // convert to bytes.
  Long64_t mfs      = (Long64_t)m_maxFileSize.value() * (Long64_t)1048576;
  Long64_t mfs_warn = mfs * 95 / 100;

  updateFiles();

  for ( const auto& f : m_files ) {
    TFile* tf = f.second.first;

#ifndef NDEBUG
    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "stream: " << f.first << "  name: " << tf->GetName() << "  size: " << tf->GetSize() << endmsg;
    }
#endif

    // Signal job to terminate if output file is too large
    if ( tf->GetSize() > mfs ) {

      m_signaledStop = true;

      fatal() << "file \"" << tf->GetName() << "\" associated with stream \"" << f.first
              << "\" has exceeded the max file size of " << m_maxFileSize.value() << "MB. Terminating Job." << endmsg;

      IEventProcessor* evt = nullptr;
      if ( service( "ApplicationMgr", evt, true ).isSuccess() ) {
        evt->stopRun();
        evt->release();
      } else {
        abort();
      }
    } else if ( tf->GetSize() > mfs_warn ) {
      warning() << "file \"" << tf->GetName() << "\" associated with stream \"" << f.first
                << "\" is at 95% of its maximum allowable file size of " << m_maxFileSize.value() << "MB" << endmsg;
    }
  }
}

initialize()

StatusCode THistSvc::initialize ( )

override

Definition at line 68 of file THistSvc.cpp.

                                {
  GlobalDirectoryRestore restore( m_svcMut );

  StatusCode status = Service::initialize();

  if ( status.isFailure() ) {
    error() << "initializing service" << endmsg;
    return status;
  }

  StatusCode st( StatusCode::SUCCESS );

  try {
    setupOutputFile();
  } catch ( GaudiException& err ) {
    error() << "Caught: " << err << endmsg;
    st = StatusCode::FAILURE;
  }

  try {
    setupInputFile();
  } catch ( GaudiException& err ) {
    error() << "Caught: " << err << endmsg;
    st = StatusCode::FAILURE;
  }

  // Protect against multiple instances of TROOT
  if ( !gROOT ) {
    static TROOT root( "root", "ROOT I/O" );
    // gDebug = 99;
  } else {
    if ( msgLevel( MSG::VERBOSE ) ) { verbose() << "ROOT already initialized, debug = " << gDebug << endmsg; }
  }

  if ( service( "IncidentSvc", p_incSvc, true ).isFailure() ) {
    error() << "unable to get the IncidentSvc" << endmsg;
    st = StatusCode::FAILURE;
  } else {
    p_incSvc->addListener( this, "EndEvent", 100, true );
  }

  if ( service( "FileMgr", p_fileMgr, true ).isFailure() ) {
    error() << "unable to get the FileMgr" << endmsg;
    st = StatusCode::FAILURE;
  } else {
    debug() << "got the FileMgr" << endmsg;
  }

  // Register open/close callback actions
  using namespace std::placeholders;
  auto boa = [this]( const Io::FileAttr* fa, const std::string& caller ) { return this->rootOpenAction( fa, caller ); };
  if ( p_fileMgr->regAction( boa, Io::OPEN, Io::ROOT ).isFailure() ) {
    error() << "unable to register ROOT file open action with FileMgr" << endmsg;
  }
  auto bea = [this]( const Io::FileAttr* fa, const std::string& caller ) {
    return this->rootOpenErrAction( fa, caller );
  };
  if ( p_fileMgr->regAction( bea, Io::OPEN_ERR, Io::ROOT ).isFailure() ) {
    error() << "unable to register ROOT file open Error action with FileMgr" << endmsg;
  }

  m_okToConnect = true;
  if ( m_delayConnect ) {
    if ( !m_inputfile.value().empty() ) setupInputFile();
    if ( !m_outputfile.value().empty() ) setupOutputFile();
    m_delayConnect = false;
  }
  m_alreadyConnectedOutFiles.clear();
  m_alreadyConnectedInFiles.clear();

  IIoComponentMgr* iomgr = nullptr;
  if ( service( "IoComponentMgr", iomgr, true ).isFailure() ) {
    error() << "unable to get the IoComponentMgr" << endmsg;
    st = StatusCode::FAILURE;
  } else {
    if ( !iomgr->io_register( this ).isSuccess() ) {
      error() << "could not register with the I/O component manager !" << endmsg;
      st = StatusCode::FAILURE;
    } else {
      bool all_good = true;
      // register input/output files...
      for ( const auto& reg : m_files ) {
        const std::string&                  fname = reg.second.first->GetName();
        const IIoComponentMgr::IoMode::Type iomode =
            ( reg.second.second == THistSvc::READ ? IIoComponentMgr::IoMode::READ : IIoComponentMgr::IoMode::WRITE );
        if ( !iomgr->io_register( this, iomode, fname ).isSuccess() ) {
          warning() << "could not register file [" << fname << "] with the I/O component manager..." << endmsg;
          all_good = false;
        } else {
          info() << "registered file [" << fname << "]... [ok]" << endmsg;
        }
      }
      if ( !all_good ) {
        error() << "problem while registering input/output files with "
                << "the I/O component manager !" << endmsg;
        st = StatusCode::FAILURE;
      }
    }
  }

  if ( st.isFailure() ) { fatal() << "Unable to initialize THistSvc" << endmsg; }

  return st;
}

io_reinit()

StatusCode THistSvc::io_reinit ( )

override

callback method to reinitialize the internal state of the component for I/O purposes (e.g.

upon fork(2))

Definition at line 1070 of file THistSvc.cpp.

                               {
  bool all_good = true;
  if ( msgLevel( MSG::DEBUG ) ) { debug() << "reinitializing I/O..." << endmsg; }

  // retrieve the I/O component manager...

  IIoComponentMgr* iomgr = nullptr;

  if ( service( "IoComponentMgr", iomgr, true ).isFailure() ) {
    error() << "could not retrieve I/O component manager !" << endmsg;
    return StatusCode::FAILURE;
  }

  GlobalDirectoryRestore restore( m_svcMut );
  // to hide the expected errors upon closing the files whose
  // file descriptors have been swept under the rug...
  gErrorIgnoreLevel = kFatal;

  for ( auto& ifile : m_files ) {
    TFile*      f     = ifile.second.first;
    std::string fname = f->GetName();
    if ( msgLevel( MSG::DEBUG ) ) {
      debug() << "file [" << fname << "] mode: [" << f->GetOption() << "] r:" << f->GetFileBytesRead()
              << " w:" << f->GetFileBytesWritten() << " cnt:" << f->GetFileCounter() << endmsg;
    }

    if ( ifile.second.second == READ ) {
      if ( msgLevel( MSG::DEBUG ) ) { debug() << "  TFile opened in READ mode: not reassigning names" << endmsg; }
      continue;
    }

    if ( !iomgr->io_retrieve( this, fname ).isSuccess() ) {
      error() << "could not retrieve new name for [" << fname << "] !!" << endmsg;
      all_good = false;
      continue;
    } else if ( fname.empty() ) {
      if ( msgLevel( MSG::DEBUG ) ) { debug() << "empty new name for [" << fname << "], skipping..." << endmsg; }
      continue;
    } else {
      if ( msgLevel( MSG::DEBUG ) ) { debug() << "got a new name [" << fname << "]..." << endmsg; }
    }

    void*     vf   = nullptr;
    Option_t* opts = f->GetOption();
    int       r    = p_fileMgr->open( Io::ROOT, name(), fname, Io::WRITE, vf, "HIST" );
    if ( r != 0 ) {
      error() << "unable to open file \"" << fname << "\" for writing" << endmsg;
      return StatusCode::FAILURE;
    }
    TFile* newfile = (TFile*)vf;
    newfile->SetOption( opts );

    if ( ifile.second.second != THistSvc::READ ) {
      copyFileLayout( newfile, f );
      ifile.second.first = newfile;
    }

    // loop over all uids and migrate them to the new file
    for ( auto& uid : m_uids ) {
      for ( auto& hid : *uid.second ) {
        if ( hid.file != f ) continue;
        TDirectory* olddir = this->changeDir( hid );
        hid.file           = newfile;
        // side-effect: create needed directories...
        TDirectory* newdir = this->changeDir( hid );
        TClass*     cl     = hid.obj->IsA();

        // migrate the objects to the new file.
        // thanks to the object model of ROOT, it is super easy.
        if ( cl->InheritsFrom( "TTree" ) ) {
          dynamic_cast<TTree*>( hid.obj )->SetDirectory( newdir );
          dynamic_cast<TTree*>( hid.obj )->Reset();
        } else if ( cl->InheritsFrom( "TH1" ) ) {
          dynamic_cast<TH1*>( hid.obj )->SetDirectory( newdir );
          dynamic_cast<TH1*>( hid.obj )->Reset();
        } else if ( cl->InheritsFrom( "TGraph" ) ) {
          olddir->Remove( hid.obj );
          newdir->Append( hid.obj );
        } else {
          error() << "id: \"" << hid.id << "\" is not a inheriting from a class "
                  << "we know how to handle (received [" << cl->GetName() << "], "
                  << "expected [TTree, TH1 or TGraph]) !" << endmsg << "attaching to current dir [" << newdir->GetPath()
                  << "] "
                  << "nonetheless..." << endmsg;
          olddir->Remove( hid.obj );
          newdir->Append( hid.obj );
        }
      }
    }
    f->ReOpen( "READ" );
    p_fileMgr->close( f, name() );
    f = newfile;
  }

  return all_good ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

merge() [1/4]

StatusCode THistSvc::merge ( const std::string &  id )

override

Merge all clones for object with a given id.

Definition at line 597 of file THistSvc.cpp.

                                                  {
  uidMap_t::iterator itr = m_uids.find( name );
  if ( itr == m_uids.end() ) {
    error() << "merge: id \"" << name << "\" not found" << endmsg;
    return StatusCode::FAILURE;
  }

  return merge( itr->second );
}

merge() [2/4]

StatusCode THistSvc::merge ( TObject *  obj )

override

Merge all clones for given TObject*.

Definition at line 607 of file THistSvc.cpp.

                                         {
  objMap_t::iterator itr = m_tobjs.find( obj );
  if ( itr != m_tobjs.end() ) {
    return merge( itr->second.first );
  } else {
    error() << "merge: unknown object " << obj << endmsg;
    return StatusCode::FAILURE;
  }
}

merge() [3/4]

StatusCode THistSvc::merge ( const THistID &  hid )

private

Helper method to merge THistID objects.

Definition at line 1765 of file THistSvc.cpp.

{ return merge( hid.id ); }

merge() [4/4]

StatusCode THistSvc::merge ( vhid_t *  vh )

private

Helper method to merge vectors of THistID.

Definition at line 1767 of file THistSvc.cpp.

                                       {
  const std::string& name = vh->at( 0 ).id;
  if ( vh->size() == 1 ) {
    debug() << "merge: id: \"" << name << "\" is size 1. nothing to do" << endmsg;
    return StatusCode::SUCCESS;
  }

  if ( !vh->at( 0 ).obj->IsA()->InheritsFrom( "TH1" ) ) {
    error() << "merge: id \"" << name << "\" is not a THn. Cannot merge" << endmsg;
    return StatusCode::FAILURE;
  }

  TList* l = new TList();
  for ( size_t i = 1; i < vh->size(); ++i ) {
    debug() << "merge: id: \"" << name << "\" (" << vh->at( i ).obj << ") adding index " << i << endmsg;
    l->Add( vh->at( i ).obj );
  }

  TH1* t0 = dynamic_cast<TH1*>( vh->at( 0 ).obj );
  if ( t0 == 0 ) {
    error() << "merge: could not dcast " << name << "(" << t0 << ") index " << 0 << " to TH1" << endmsg;
    return StatusCode::FAILURE;
  }

  Long64_t n = t0->Merge( l );

  debug() << "merge: id: \"" << name << "\" merged " << n << " entries" << endmsg;

  for ( size_t i = 1; i < vh->size(); ++i ) {
    TH1* th = dynamic_cast<TH1*>( vh->at( i ).obj );
    if ( th != 0 ) {
      debug() << "clearing index " << i << "(" << th << ")" << endmsg;
      th->SetDirectory( nullptr );
      th->Reset();
    } else {
      error() << "merge: could not dcast " << name << " index " << i << " to TH1" << endmsg;
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

MergeRootFile()

void THistSvc::MergeRootFile ( TDirectory *  target, TDirectory *  source  )

private

Definition at line 1511 of file THistSvc.cpp.

                                                                     {
  if ( msgLevel( MSG::DEBUG ) ) { debug() << "Target path: " << target->GetPath() << endmsg; }
  TString path( (char*)strstr( target->GetPath(), ":" ) );
  path.Remove( 0, 2 );

  source->cd( path );
  TDirectory* current_sourcedir = gDirectory;

  // loop over all keys in this directory
  TList* lkeys = current_sourcedir->GetListOfKeys();
  int    nkeys = lkeys->GetEntries();
  TKey*  key   = nullptr;
  for ( int jj = 0; jj < nkeys; jj++ ) {
    key                          = (TKey*)lkeys->At( jj );
    std::string pathnameinsource = current_sourcedir->GetPath() + std::string( "/" ) + key->GetName();
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "Reading Key:" << pathnameinsource << endmsg; }
    TObject* obj = source->Get( pathnameinsource.c_str() );

    if ( obj ) {
      if ( obj->IsA()->InheritsFrom( "TDirectory" ) ) {
        // it's a subdirectory
        if ( msgLevel( MSG::DEBUG ) ) { debug() << "Found subdirectory " << obj->GetName() << endmsg; }

        // create a new subdir of same name and title in the target file
        target->cd();
        TDirectory* newtargetdir = target->mkdir( obj->GetName(), obj->GetTitle() );

        MergeRootFile( newtargetdir, source );

      } else if ( obj->IsA()->InheritsFrom( "TTree" ) ) {
        if ( msgLevel( MSG::DEBUG ) ) { debug() << "Found TTree " << obj->GetName() << endmsg; }
        TTree* mytree   = dynamic_cast<TTree*>( obj );
        int    nentries = (int)mytree->GetEntries();
        mytree->SetBranchStatus( "*", 1 );

        if ( msgLevel( MSG::DEBUG ) ) { debug() << "Dumping TTree " << nentries << " entries" << endmsg; }
        target->cd();
        mytree->CloneTree();

      } else {
        target->cd();
        obj->Write( key->GetName() );
      }
    }
  }
}

parseString()

void THistSvc::parseString ( const std::string &  id, std::string &  root, std::string &  rem  ) const

private

Definition at line 1594 of file THistSvc.cpp.

                                                                                       {
  auto pos = id.find( "/" );

  if ( pos == std::string::npos ) {
    root.clear();
    rem = id;
  } else if ( pos == 0 ) {
    parseString( id.substr( 1 ), root, rem );
  } else {
    root = id.substr( 0, pos );
    rem  = id.substr( pos + 1 );
  }
}

readHist()

template<typename T >

T * THistSvc::readHist ( const std::string &  name ) const

private

Definition at line 1184 of file THistSvc.cpp.

                                                 {
  return dynamic_cast<T*>( readHist_i<T>( id ) );
}

readHist_i()

template<typename T >

T * THistSvc::readHist_i ( const std::string &  name ) const

private

Definition at line 204 of file THistSvc.icc.

                                                   {
  GlobalDirectoryRestore restore( m_svcMut );

  std::string idr( id );
  removeDoubleSlash( idr );

  std::string stream, rem, dir, fdir, bdir, fdir2;
  TFile*      file = nullptr;

  if ( !findStream( idr, stream, rem, file ) ) { return nullptr; }

  if ( !file ) {
    error() << "no associated file found" << endmsg;
    return nullptr;
  }

  file->cd( "/" );

  fdir  = idr;
  bdir  = stripDirectoryName( fdir );
  fdir2 = fdir;
  while ( ( dir = stripDirectoryName( fdir ) ) != "" ) {
    if ( !gDirectory->GetKey( dir.c_str() ) ) {
      error() << "Directory \"" << fdir2 << "\" doesnt exist in " << file->GetName() << endmsg;
      return nullptr;
    }
    gDirectory->cd( dir.c_str() );
  }

  TObject* to = nullptr;
  gDirectory->GetObject( fdir.c_str(), to );

  if ( !to ) {
    error() << "Could not get obj \"" << fdir << "\" in " << gDirectory->GetPath() << endmsg;
    return nullptr;
  }

  T* hist = dynamic_cast<T*>( to );
  if ( hist == nullptr ) {
    error() << "Could not convert \"" << idr << "\" to a " << System::typeinfoName( typeid( *hist ) ) << " as is a "
            << to->IsA()->GetName() << endmsg;
    return nullptr;
  }

  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "Read in " << hist->IsA()->GetName() << "  \"" << hist->GetName() << "\" from file " << file->GetName()
            << endmsg;
    hist->Print();
  }

  return hist;
}

readTree()

TTree * THistSvc::readTree ( const std::string &  name ) const

private

Definition at line 1188 of file THistSvc.cpp.

{ return dynamic_cast<TTree*>( readHist_i<TTree>( id ) ); }

regGraph() [1/3]

StatusCode THistSvc::regGraph ( const std::string &  name )

override

Register a new TGraph with a given name.

Definition at line 401 of file THistSvc.cpp.

                                                   {
  std::unique_ptr<TGraph> graph = std::make_unique<TGraph>();
  return regHist_i( std::move( graph ), id, false );
}

regGraph() [2/3]

StatusCode THistSvc::regGraph ( const std::string &  name, std::unique_ptr< TGraph >  graph  )

override

Register an existing TGraph with a given name and moved unique_ptr.

Definition at line 406 of file THistSvc.cpp.

                                                                                {
  if ( strcmp( graph->GetName(), "Graph" ) == 0 ) {
    std::string            id2( id );
    std::string::size_type i = id2.rfind( "/" );
    if ( i != std::string::npos ) { id2.erase( 0, i + 1 ); }

    info() << "setting name of TGraph id: \"" << id << "\" to \"" << id2 << "\" since it is unset" << endmsg;
    graph->SetName( id2.c_str() );
  }

  return regHist_i( std::move( graph ), id, false );
}

regGraph() [3/3]

StatusCode THistSvc::regGraph ( const std::string &  name, TGraph *  graph_ptr  )

overridevirtual

Deprecated:

{Just kept for compatibiltiy to current ATLAS code.

Pleas use std::unique_ptrs instead!} Register a new TGraph with a given name and a raw pointer

Definition at line 419 of file THistSvc.cpp.

                                                                      {
  std::unique_ptr<TGraph> graph( graph_ptr );
  if ( strcmp( graph->GetName(), "Graph" ) == 0 ) {
    std::string            id2( id );
    std::string::size_type i = id2.rfind( "/" );
    if ( i != std::string::npos ) { id2.erase( 0, i + 1 ); }

    info() << "setting name of TGraph id: \"" << id << "\" to \"" << id2 << "\" since it is unset" << endmsg;
    graph->SetName( id2.c_str() );
  }

  return regHist_i( std::move( graph ), id, false );
}

regHist() [1/4]

StatusCode THistSvc::regHist ( const std::string &  name )

override

Register a new ROOT histogram TH*X with a name.

Definition at line 319 of file THistSvc.cpp.

                                                  {
  std::unique_ptr<TH1> hist = nullptr;
  return regHist_i( std::move( hist ), id, false );
}

regHist() [2/4]

StatusCode THistSvc::regHist ( const std::string &  name, std::unique_ptr< TH1 >  hist  )

override

Register an existing ROOT histogram TH*X with name and moved unique_ptr.

Parameters

[in]	name	defines the histogram id/name under which it is recorded
[in]	hist	transfers ownership of the histogram to the THistSvc

Definition at line 324 of file THistSvc.cpp.

                                                                           {
  return regHist_i( std::move( hist ), id, false );
}

regHist() [3/4]

StatusCode THistSvc::regHist ( const std::string &  name, std::unique_ptr< TH1 >  hist, TH1 *  hist_ptr  )

override

Register an existing ROOT histogram TH*X with name and moved unique_ptr.

Parameters

[in]	name	defines the histogram id/name under which it is recorded
[in]	hist	transfers ownership of the histogram to the THistSvc
[out]	hist_ptr	for compatibility: return raw pointer to managed object to support common usage in Athena

Definition at line 328 of file THistSvc.cpp.

                                                                                          {
  // This is only to support a common use case where the histogram is used after its registration
  if ( hist_ptr != nullptr ) { hist_ptr = hist.get(); }
  return regHist_i( std::move( hist ), id, false );
}

regHist() [4/4]

StatusCode THistSvc::regHist ( const std::string &  name, TH1 *  hist_ptr  )

override

Deprecated:

{Just for compatibility purposes.

Ownership should be clearly managed.} Register an existing ROOT histogram TH*X with name and pointer

Definition at line 334 of file THistSvc.cpp.

                                                                 {
  std::unique_ptr<TH1> hist( hist_ptr );
  return regHist_i( std::move( hist ), id, false );
}

regHist_i() [1/2]

template<typename T >

StatusCode THistSvc::regHist_i ( std::unique_ptr< T >  hist, const std::string &  name, bool  shared  )

private

Definition at line 17 of file THistSvc.icc.

                                                                                        {
  THistID* hid = nullptr;
  return regHist_i( std::move( hist ), id, shared, hid );
}

regHist_i() [2/2]

template<typename T >

StatusCode THistSvc::regHist_i ( std::unique_ptr< T >  hist, const std::string &  name, bool  shared, THistID *&  hid  )

private

Definition at line 23 of file THistSvc.icc.

                                                                                                               {
  GlobalDirectoryRestore restore( m_svcMut );
  phid = nullptr;

  // It is sad that we lose propper memory management here
  T* hist = nullptr;
  if ( hist_unique.get() != nullptr ) { hist = hist_unique.release(); }
  debug() << "regHist_i obj: " << hist << "  id: " << id << "  s: " << shared << endmsg;

  std::string idr( id );
  removeDoubleSlash( idr );

  if ( idr.find( "/" ) == idr.length() ) {
    error() << "Badly formed identifier \"" << idr << "\": "
            << "Must not end with a /" << endmsg;
    delete hist;
    return StatusCode::FAILURE;
  }

  TFile*      f = nullptr;
  std::string stream, name;
  if ( !findStream( idr, stream, name, f ) ) {
    error() << "Could not register id: \"" << idr << "\"" << endmsg;
    delete hist;
    return StatusCode::FAILURE;
  }

  std::string uid = "/" + stream + "/" + name;

  uidMap_t::iterator uitr = m_uids.find( uid );
  bool               exists( false );
  if ( uitr != m_uids.end() ) {
    exists      = true;
    TObject* t1 = uitr->second->at( 0 ).obj;
    if ( hist->Compare( t1 ) != 0 ) {
      error() << "previously registered object with identifier \"" << uid << "\" does not compare to this one"
              << endmsg;
      delete hist;
      return StatusCode::FAILURE;
    } else {
      debug() << "previously registered id \"" << uid << "\": num " << uitr->second->size() << endmsg;
    }
  }

  bool temp = false;
  if ( !f ) {
    temp = true;
    if ( msgLevel( MSG::DEBUG ) ) { debug() << "Historgram with id \"" << idr << "\" is temporary" << endmsg; }
  }

  TObject* to = nullptr;
  THistID  hid;
  // check to see if this hist is to be read in;
  if ( !temp && m_files.find( stream )->second.second == READ ) {
    if ( hist != 0 ) { warning() << "Registering id: \"" << idr << "\" with non zero pointer!" << endmsg; }

    hist = readHist_i<T>( idr );
    if ( hist == nullptr ) {
      error() << "Unable to read in hist" << endmsg;
      delete hist;
      return StatusCode::FAILURE;
    }
    to  = dynamic_cast<TObject*>( hist );
    hid = THistID( uid, temp, to, f, m_files.find( stream )->second.second );
  } else if ( !hist ) {
    error() << "Unable to read in hist with id: \"" << idr << "\"" << endmsg;
    delete hist;
    return StatusCode::FAILURE;
  } else {
    to = dynamic_cast<TObject*>( hist );
    if ( to == nullptr ) {
      error() << "Could not dcast to TObject. id: \"" << idr << "\"" << endmsg;
      delete hist;
      return StatusCode::FAILURE;
    }

    auto oitr = m_tobjs.find( to );
    if ( oitr != m_tobjs.end() ) {
      error() << "already registered id: \"" << idr << "\" with identifier \""
              << oitr->second.first->at( oitr->second.second ).id << "\"" << endmsg;
      delete hist;
      return StatusCode::FAILURE;
    }

    const auto findF = m_files.find( stream );
    hid = ( findF != m_files.end() ? THistID( uid, temp, to, f, findF->second.second ) : THistID( uid, temp, to, f ) );

    hid.shared      = shared;
    TDirectory* dir = changeDir( hid );

    if ( dynamic_cast<TTree*>( hist ) ) {
      dynamic_cast<TTree*>( hist )->SetDirectory( dir );
    } else if ( dynamic_cast<TH1*>( hist ) ) {
      dynamic_cast<TH1*>( hist )->SetDirectory( dir );
    } else if ( dynamic_cast<TGraph*>( hist ) ) {
      dir->Append( hist );
    } else {
      error() << "id: \"" << idr << "\" is not a TH, TTree, or TGraph. Attaching it to current dir." << endmsg;
      dir->Append( hist );
    }
  }

  std::string fname;
  if ( !f ) {
    fname = "none";
  } else {
    fname = f->GetName();
  }

  debug() << "Registering" << ( shared ? " shared " : " " ) << System::typeinfoName( typeid( *hist ) ) << " title: \""
          << hist->GetTitle() << "\"  id: \"" << uid
          << "\"  dir: "
          //          << hist->GetDirectory()->GetPath() << "  "
          << changeDir( hid )->GetPath() << "  file: " << fname << endmsg;

  // create a mutex for all shared histograms
  if ( shared ) { hid.mutex = new histMut_t; }

  if ( exists ) {
    vhid_t* vi = uitr->second;
    vi->push_back( hid );
    phid = &( vi->back() );

    m_tobjs.emplace( to, std::pair<vhid_t*, size_t>( vi, vi->size() - 1 ) );
  } else {
    vhid_t* vi = new vhid_t{hid};
    m_hlist.emplace( m_hlist.end(), vi );

    phid = &( vi->back() );
    m_uids.emplace( uid, vi );
    m_ids.emplace( name, vi );

    m_tobjs.emplace( to, std::pair<vhid_t*, size_t>( vi, 0 ) );
  }

  debug() << "regHist_i  THistID: " << hid << endmsg;

  return StatusCode::SUCCESS;
}

regShared() [1/4]

StatusCode THistSvc::regShared ( const std::string &  name, std::unique_ptr< TH1 >  hist, LockedHandle< TH1 > &  lh  )

override

Register shared object of type TH1 and return LockedHandle for that object.

Definition at line 442 of file THistSvc.cpp.

                                                                                                    {
  lh = regShared_i<TH1>( id, std::move( hist ) );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

regShared() [2/4]

StatusCode THistSvc::regShared ( const std::string &  name, std::unique_ptr< TH2 >  hist, LockedHandle< TH2 > &  lh  )

override

Register shared object of type TH2 and return LockedHandle for that object.

Definition at line 451 of file THistSvc.cpp.

                                                                                                    {
  lh = regShared_i<TH2>( id, std::move( hist ) );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

regShared() [3/4]

StatusCode THistSvc::regShared ( const std::string &  name, std::unique_ptr< TH3 >  hist, LockedHandle< TH3 > &  lh  )

override

Register shared object of type TH3 and return LockedHandle for that object.

Definition at line 460 of file THistSvc.cpp.

                                                                                                    {
  lh = regShared_i<TH3>( id, std::move( hist ) );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

regShared() [4/4]

StatusCode THistSvc::regShared ( const std::string &  name, std::unique_ptr< TGraph >  graph, LockedHandle< TGraph > &  lh  )

override

Register shared object of type TGraph and return LockedHandle for that object.

Definition at line 469 of file THistSvc.cpp.

                                                                                                           {
  lh = regShared_i<TGraph>( id, std::move( graph ) );
  if ( lh ) {
    return StatusCode::SUCCESS;
  } else {
    return StatusCode::FAILURE;
  }
}

regShared_i()

template<typename T >

LockedHandle< T > THistSvc::regShared_i ( const std::string &  id, std::unique_ptr< T >  hist  )

private

Definition at line 258 of file THistSvc.icc.

                                                                                  {
  LockedHandle<T> lh( nullptr, nullptr );
  const THistID*  hid = nullptr;
  if ( findHistID( id, hid ) == 0 ) {
    T*       phist = hist.get();
    THistID* phid  = nullptr;
    if ( regHist_i( std::move( hist ), id, true, phid ).isSuccess() ) {
      lh.set( phist, phid->mutex );

    } else {
      error() << "regSharedHist: unable to register shared hist with id \"" << id << "\"" << endmsg;
    }
  } else {
    if ( !hid->shared ) {
      error() << "regSharedHist: previously register Hist with id \"" << id << "\" was not marked shared" << endmsg;
    }

    if ( hist->Compare( hid->obj ) != 0 ) {
      error() << "regSharedHist: Histogram " << id << " does not compare with " << hid << endmsg;
    } else {
      T* phist = dynamic_cast<T*>( hid->obj );
      if ( phist == 0 ) {
        error() << "regSharedHist: unable to dcast retrieved shared hist \"" << id << "\" of type "
                << hid->obj->IsA()->GetName() << " to requested type " << System::typeinfoName( typeid( T ) ) << endmsg;
      } else {
        lh.set( phist, hid->mutex );
        delete hist.release();
      }
    }
  }
  return lh;
}

regTree() [1/3]

StatusCode THistSvc::regTree ( const std::string &  name )

override

Register a new TTree with a given name.

Definition at line 366 of file THistSvc.cpp.

                                                  {
  std::unique_ptr<TTree> tree = nullptr;
  return regHist_i( std::move( tree ), id, false );
}

regTree() [2/3]

StatusCode THistSvc::regTree ( const std::string &  name, std::unique_ptr< TTree >  tree  )

override

Register an existing TTree with a given name and moved unique_ptr.

Definition at line 371 of file THistSvc.cpp.

                                                                             {
  StatusCode sc = regHist_i( std::move( tree ), id, false );
  TTree*     tr = nullptr;
  if ( getTree( id, tr ).isSuccess() && sc.isSuccess() ) {
    if ( m_autoSave != 0 ) { tr->SetAutoSave( m_autoSave ); }
    tr->SetAutoFlush( m_autoFlush );
  }
  return sc;
}

regTree() [3/3]

StatusCode THistSvc::regTree ( const std::string &  name, TTree *  tree_ptr  )

override

Deprecated:

{Just kept for compatibiltiy to current ATLAS code.

Pleas use std::unique_ptrs instead!} Register a new TTree with a given name and a raw pointer

Definition at line 381 of file THistSvc.cpp.

                                                                   {
  std::unique_ptr<TTree> tree( tree_ptr );
  StatusCode             sc = regHist_i( std::move( tree ), id, false );
  TTree*                 tr = nullptr;
  if ( getTree( id, tr ).isSuccess() && sc.isSuccess() ) {
    if ( m_autoSave != 0 ) { tr->SetAutoSave( m_autoSave ); }
    tr->SetAutoFlush( m_autoFlush );
  }
  return sc;
}

reinitialize()

StatusCode THistSvc::reinitialize ( )

override

Definition at line 173 of file THistSvc.cpp.

                                  {
  GlobalDirectoryRestore restore( m_svcMut );
  warning() << "reinitialize not implemented" << endmsg;
  return StatusCode::SUCCESS;
}

removeDoubleSlash()

void THistSvc::removeDoubleSlash ( std::string &  id ) const

private

Definition at line 1507 of file THistSvc.cpp.

                                                      {
  while ( id.find( "//" ) != std::string::npos ) { id.replace( id.find( "//" ), 2, "/" ); }
}

rootOpenAction()

StatusCode THistSvc::rootOpenAction ( FILEMGR_CALLBACK_ARGS  )

private

Definition at line 1809 of file THistSvc.cpp.

                                                                                   {
  if ( fa->tech() != Io::ROOT ) {
    // This should never happen
    return StatusCode::SUCCESS;
  }

  if ( fa->desc() != "HIST" ) { return StatusCode::SUCCESS; }

  p_incSvc->fireIncident( FileIncident( caller, "OpenHistFile", fa->name() ) );

  if ( fa->flags().isRead() ) {
    p_incSvc->fireIncident( FileIncident( caller, "BeginHistFile", fa->name() ) );
  } else if ( fa->flags().isWrite() ) {
    p_incSvc->fireIncident( FileIncident( caller, IncidentType::BeginOutputFile, fa->name() ) );
  } else {
    // for Io::RW
    p_incSvc->fireIncident( FileIncident( caller, IncidentType::BeginOutputFile, fa->name() ) );
  }

  return StatusCode::SUCCESS;
}

rootOpenErrAction()

StatusCode THistSvc::rootOpenErrAction ( FILEMGR_CALLBACK_ARGS  )

private

Definition at line 1831 of file THistSvc.cpp.

                                                                                      {
  if ( fa->tech() != Io::ROOT ) {
    // This should never happen
    return StatusCode::SUCCESS;
  }

  if ( fa->desc() != "HIST" ) { return StatusCode::SUCCESS; }

  if ( fa->flags().isRead() ) {
    p_incSvc->fireIncident( FileIncident( caller, IncidentType::FailInputFile, fa->name() ) );
  } else if ( fa->flags().isWrite() ) {
    p_incSvc->fireIncident( FileIncident( caller, IncidentType::FailOutputFile, fa->name() ) );
  } else {
    // for Io::RW
    p_incSvc->fireIncident( FileIncident( caller, "FailRWFile", fa->name() ) );
  }

  return StatusCode::SUCCESS;
}

setupInputFile()

void THistSvc::setupInputFile ( )

private

call-back method to handle input stream property

Definition at line 1608 of file THistSvc.cpp.

                              {
  if ( FSMState() < Gaudi::StateMachine::CONFIGURED || !m_okToConnect ) {
    debug() << "Delaying connection of Input Files until Initialize"
            << ". now in " << FSMState() << endmsg;

    m_delayConnect = true;
  } else {
    debug() << "Now connecting of Input Files" << endmsg;

    StatusCode sc = StatusCode::SUCCESS;

    for ( const auto& itr : m_inputfile.value() ) {
      if ( m_alreadyConnectedInFiles.end() != m_alreadyConnectedInFiles.find( itr ) ) { continue; }
      if ( connect( itr ).isFailure() ) {
        sc = StatusCode::FAILURE;
      } else {
        m_alreadyConnectedInFiles.insert( itr );
      }
    }

    if ( !sc.isSuccess() ) { throw GaudiException( "Problem connecting inputfile !!", name(), StatusCode::FAILURE ); }
  }
}

setupOutputFile()

void THistSvc::setupOutputFile ( )

private

call-back method to handle output stream property

Definition at line 1632 of file THistSvc.cpp.

                               {
  if ( FSMState() < Gaudi::StateMachine::CONFIGURED || !m_okToConnect ) {
    debug() << "Delaying connection of Input Files until Initialize"
            << ". now in " << FSMState() << endmsg;
    m_delayConnect = true;
  } else {
    StatusCode sc = StatusCode::SUCCESS;
    for ( const auto& itr : m_outputfile.value() ) {
      if ( m_alreadyConnectedOutFiles.end() != m_alreadyConnectedOutFiles.find( itr ) ) { continue; }
      if ( connect( itr ).isFailure() ) {
        sc = StatusCode::FAILURE;
      } else {
        m_alreadyConnectedOutFiles.insert( itr );
      }
    }

    if ( !sc.isSuccess() ) { throw GaudiException( "Problem connecting outputfile !!", name(), StatusCode::FAILURE ); }
  }
}

stripDirectoryName()

std::string THistSvc::stripDirectoryName ( std::string &  dir ) const

private

Definition at line 1491 of file THistSvc.cpp.

                                                             {
  std::string::size_type i = dir.find( "/" );

  if ( i == std::string::npos ) return {};

  if ( i == 0 ) {
    dir.erase( 0, 1 );
    return stripDirectoryName( dir );
  }

  std::string root = dir.substr( 0, i );
  dir.erase( 0, i );

  return root;
}

updateFiles()

void THistSvc::updateFiles ( )

private

Handle case where TTree grows beyond TTree::fgMaxTreeSize.

Definition at line 1190 of file THistSvc.cpp.

                           {
  // If TTrees grow beyond TTree::fgMaxTreeSize, a new file is
  // automatically created by root, and the old one closed. We
  // need to migrate all the UIDs over to show the correct file
  // pointer. This is ugly.

  if ( msgLevel( MSG::DEBUG ) ) debug() << "updateFiles()" << endmsg;

  for ( auto uitr = m_uids.begin(); uitr != m_uids.end(); ++uitr ) {
    for ( auto& hid : *( uitr->second ) ) {
#ifndef NDEBUG
      if ( msgLevel( MSG::VERBOSE ) )
        verbose() << " update: " << uitr->first << " " << hid.id << " " << hid.mode << endmsg;
#endif
      TObject* to      = hid.obj;
      TFile*   oldFile = hid.file;
      if ( !to ) {
        warning() << uitr->first << ": TObject == 0" << endmsg;
      } else if ( hid.temp || hid.mode == READ ) {
// do nothing - no need to check how big the file is since we
// are just reading it.
#ifndef NDEBUG
        if ( msgLevel( MSG::VERBOSE ) ) verbose() << "     skipping" << endmsg;
#endif
      } else if ( to->IsA()->InheritsFrom( "TTree" ) ) {
        TTree* tr      = dynamic_cast<TTree*>( to );
        TFile* newFile = tr->GetCurrentFile();

        if ( oldFile != newFile ) {
          std::string newFileName = newFile->GetName();
          std::string oldFileName, streamName, rem;
          TFile*      dummy = nullptr;
          findStream( hid.id, streamName, rem, dummy );

          for ( auto& itr : m_files ) {
            if ( itr.second.first == oldFile ) { itr.second.first = newFile; }
          }

          for ( auto uitr2 = uitr; uitr2 != m_uids.end(); ++uitr2 ) {
            for ( auto& hid2 : *( uitr2->second ) ) {
              if ( hid2.file == oldFile ) { hid2.file = newFile; }
            }
          }

          auto sitr = std::find_if( std::begin( m_fileStreams ), std::end( m_fileStreams ),
                                    [&]( streamMap::const_reference s ) { return s.second == streamName; } );
          if ( sitr != std::end( m_fileStreams ) ) oldFileName = sitr->first;

#ifndef NDEBUG
          if ( msgLevel( MSG::DEBUG ) ) {
            debug() << "migrating uid: " << hid.id << "   stream: " << streamName << "   oldFile: " << oldFileName
                    << "   newFile: " << newFileName << endmsg;
          }
#endif

          if ( !oldFileName.empty() ) {
            auto i = m_fileStreams.lower_bound( oldFileName );
            while ( i != std::end( m_fileStreams ) && i->first == oldFileName ) {
#ifndef NDEBUG
              if ( msgLevel( MSG::DEBUG ) ) {
                debug() << "changing filename \"" << i->first << "\" to \"" << newFileName << "\" for stream \""
                        << i->second << "\"" << endmsg;
              }
#endif
              std::string nm = std::move( i->second );
              i              = m_fileStreams.erase( i );
              m_fileStreams.emplace( newFileName, std::move( nm ) );
            }
          } else {
            error() << "Problems updating fileStreams with new file name" << endmsg;
          }
        }
      }
    }
  }
}

writeObjectsToFile()

StatusCode THistSvc::writeObjectsToFile ( )

private

Definition at line 1267 of file THistSvc.cpp.

                                        {
  updateFiles();

  std::for_each( m_files.begin(), m_files.end(), []( std::pair<const std::string, std::pair<TFile*, Mode>>& i ) {
    auto mode = i.second.second;
    auto file = i.second.first;
    if ( mode == WRITE || mode == UPDATE || mode == SHARE ) {
      file->Write( "", TObject::kOverwrite );
    } else if ( mode == APPEND ) {
      file->Write( "" );
    }
  } );

  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << "THistSvc::writeObjectsToFile()::List of Files connected in ROOT " << endmsg;
    TSeqCollection* filelist = gROOT->GetListOfFiles();
    for ( int ii = 0; ii < filelist->GetEntries(); ii++ ) {
      debug() << "THistSvc::writeObjectsToFile()::List of Files connected in ROOT: \"" << filelist->At( ii )->GetName()
              << "\"" << endmsg;
    }
  }

  return StatusCode::SUCCESS;
}

Member Data Documentation

m_alreadyConnectedInFiles

std::set<std::string> THistSvc::m_alreadyConnectedInFiles

private

list of already connected files.

This is to keep track of files registered by the setupInputFile callback method

Definition at line 241 of file THistSvc.h.

m_alreadyConnectedOutFiles

std::set<std::string> THistSvc::m_alreadyConnectedOutFiles

private

list of already connected files.

This is to keep track of files registered by the setupOutputFile callback method

Definition at line 245 of file THistSvc.h.

m_autoFlush

Gaudi::Property<int> THistSvc::m_autoFlush {this, "AutoFlush", 0}

private

Definition at line 340 of file THistSvc.h.

m_autoSave

Gaudi::Property<int> THistSvc::m_autoSave {this, "AutoSave", 0}

private

Definition at line 339 of file THistSvc.h.

m_compressionLevel

Gaudi::Property<int> THistSvc::m_compressionLevel

private

Initial value:

{this, "CompressionLevel", 1, [this]( auto& ) {
                                            this->warning()
                                                << "\"CompressionLevel\" Property has been deprecated. "
                                                << "Set it via the \"CL=\" parameter in the \"Output\" Property"
                                                << endmsg;
                                          }}

Definition at line 345 of file THistSvc.h.

m_curstream

std::string THistSvc::m_curstream

mutableprivate

Definition at line 363 of file THistSvc.h.

m_delayConnect

bool THistSvc::m_delayConnect = false

private

Definition at line 360 of file THistSvc.h.

m_files

std::map<std::string, std::pair<TFile*, Mode> > THistSvc::m_files

private

Definition at line 265 of file THistSvc.h.

m_fileStreams

streamMap THistSvc::m_fileStreams

private

Definition at line 267 of file THistSvc.h.

m_hlist

hlist_t THistSvc::m_hlist

private

Definition at line 258 of file THistSvc.h.

m_ids

idMap_t THistSvc::m_ids

private

Definition at line 260 of file THistSvc.h.

m_inputfile

Gaudi::Property<std::vector<std::string> > THistSvc::m_inputfile {this, "Input", {}, &THistSvc::setupInputFile}

private

Definition at line 352 of file THistSvc.h.

m_maxFileSize

Gaudi::Property<int> THistSvc::m_maxFileSize

private

Initial value:

{this, "MaxFileSize", 10240,
                                     "maximum file size in MB. if exceeded,"
                                     " will cause an abort. -1 to never check."}

Definition at line 342 of file THistSvc.h.

m_okToConnect

bool THistSvc::m_okToConnect = false

private

Definition at line 361 of file THistSvc.h.

m_outputfile

Gaudi::Property<std::vector<std::string> > THistSvc::m_outputfile {this, "Output", {}, &THistSvc::setupOutputFile}

private

Definition at line 351 of file THistSvc.h.

m_print

Gaudi::Property<bool> THistSvc::m_print {this, "PrintAll", false}

private

Definition at line 341 of file THistSvc.h.

m_Rstream

std::vector<std::string> THistSvc::m_Rstream

private

Definition at line 237 of file THistSvc.h.

m_sharedFiles

std::map<std::string, std::string> THistSvc::m_sharedFiles

private

Definition at line 270 of file THistSvc.h.

m_signaledStop

bool THistSvc::m_signaledStop = false

private

Definition at line 359 of file THistSvc.h.

m_svcMut

THistSvcMutex_t THistSvc::m_svcMut

mutableprivate

Definition at line 365 of file THistSvc.h.

m_tobjs

objMap_t THistSvc::m_tobjs

private

Definition at line 263 of file THistSvc.h.

m_uids

uidMap_t THistSvc::m_uids

private

Definition at line 259 of file THistSvc.h.

m_Wstream

std::vector<std::string> THistSvc::m_Wstream

private

Definition at line 237 of file THistSvc.h.

p_fileMgr

IFileMgr* THistSvc::p_fileMgr = nullptr

private

Definition at line 357 of file THistSvc.h.

p_incSvc

IIncidentSvc* THistSvc::p_incSvc = nullptr

private

Definition at line 356 of file THistSvc.h.

---

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

• GaudiSvc/src/THistSvc/THistSvc.h
• GaudiSvc/src/THistSvc/THistSvc.cpp
• GaudiSvc/src/THistSvc/THistSvc.icc