#include <TEvent.h>

Collaboration diagram for POOL::TEvent:

Public Types
enum	EReadMode { kTreeAccess = -2 , kPOOLAccess = -1 , kBranchAccess = 0 , kClassAccess = 1 , kAthenaAccess = 2 , kUndefinedAccess = 3 }

Public Member Functions
	TEvent (const std::string &name="StoreGateSvc")
	TEvent (EReadMode mode, const std::string &name="StoreGateSvc")
	~TEvent ()
ServiceHandle< IEventSeek > &	evtLoop ()
ServiceHandle< StoreGateSvc > &	evtStore ()
ServiceHandle< StoreGateSvc > &	inputMetaStore ()
template<typename T>
void	setEvtSelProperty (const char *name, const T &val)
template<typename T>
StatusCode	retrieve (const T *&obj)
template<typename T>
StatusCode	retrieve (T *&obj)
template<typename T>
StatusCode	retrieve (const T *&obj, const std::string &key)
template<typename T>
StatusCode	retrieve (T *&obj, const std::string &key)
template<typename T>
StatusCode	retrieveMetaInput (const T *&obj, const std::string &key)
int	getEntry (long entry)
long	getEntries ()
StatusCode	readFrom (TFile *file)
StatusCode	readFrom (const char *file)
StatusCode	readFrom (TChain *files)
void	setActive ()
	ensure we are the active store, for the purpose of element links etc
PyObject *	retrieve (PyObject tp, PyObject pykey)
	retrieve and record method for python
PyObject *	get_item (PyObject *pykey)
PyObject *	contains (PyObject tp, PyObject pykey)
PyObject *	retrieveMetaInput (PyObject tp, PyObject pykey)
PyObject *	record (PyObject obj, PyObject pykey, bool allowMods=true, bool resetOnly=true, bool noHist=false)

Static Public Member Functions
static IAppMgrUI *	Init (const char *options="POOLRootAccess/basic.opts")

Private Attributes
long	m_curEntry = -1
long	m_size = -1
IEventProcessor *	m_evtProcessor
ServiceHandle< IIncidentSvc >	m_incSvc
ServiceHandle< Gaudi::Interfaces::IOptionsSvc >	m_joSvc
ServiceHandle< IEventSeek >	m_evtLoop
ServiceHandle< IEvtSelectorSeek >	m_evtSelect
ServiceHandle< StoreGateSvc >	m_evtStore
ServiceHandle< StoreGateSvc >	m_inputMetaStore

Detailed Description

Definition at line 40 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

Member Enumeration Documentation

◆ EReadMode

enum POOL::TEvent::EReadMode

Enumerator
kTreeAccess
kPOOLAccess
kBranchAccess
kClassAccess
kAthenaAccess
kUndefinedAccess

Definition at line 42 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

                        {
       kTreeAccess = -2, //read the TTree directly
           kPOOLAccess = -1, //cannot be used in the same session as the other access modes
           kBranchAccess = 0,
           kClassAccess = 1,
           kAthenaAccess = 2,
           kUndefinedAccess = 3
         };

Constructor & Destructor Documentation

◆ TEvent() [1/2]

POOL::TEvent::TEvent ( const std::string & name = "StoreGateSvc" )

Definition at line 46 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

46: TEvent( kPOOLAccess , name ) { }

POOL::TEvent::TEvent

TEvent(const std::string &name="StoreGateSvc")

Definition PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx:46

◆ TEvent() [2/2]

POOL::TEvent::TEvent	(	EReadMode	mode,
		const std::string &	name = "StoreGateSvc" )

Definition at line 48 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                                    : 
   m_evtProcessor (nullptr),
   m_incSvc("IncidentSvc","TEvent"+name),
   m_joSvc("JobOptionsSvc","TEvent"+name),
   m_evtLoop("AthenaEventLoopMgr/"+name+"_EventLoopMgr","TEvent"+name),
   m_evtSelect("EventSelectorAthenaPool/"+name+"_EventSelector","TEvent"+name),
   m_evtStore("StoreGateSvc/"+name,"TEvent"+name),
   m_inputMetaStore("InputMetaDataStore","TEvent"+name) /*fixme, when reading multiple files at once?*/ {
 
   Gaudi::Init();
 
   //SEEMS TO CAUSE INITIALIZE LOOP if(name=="StoreGateSvc") m_evtSelect.setName("EventSelector"); //use default selector name if we use default storegate
 
   //FIXME: Should protect against attempt to mix POOL with nonPOOL
   if(mode==kPOOLAccess) {
     //add AthenaPoolCnvSvc to the EventPersistencySvc (ideally the selector should add this itself!!)
     ServiceHandle<IService> epSvc("EventPersistencySvc","TEvent"+name);
     AAH::setProperty( epSvc , "CnvServices" , "['AthenaPoolCnvSvc']" ).ignore(); //FIXME: perhaps should append rather than overwrite
     //add the AthenaPoolAddressProviderSvc to ProxyProviderSvc
     ServiceHandle<IService> ppSvc("ProxyProviderSvc","TEvent"+name);
     AAH::setProperty( ppSvc , "ProviderNames", "['MetaDataSvc', 'AthenaPoolAddressProviderSvc']" ).ignore();
   } else if(mode==kTreeAccess) {
     //switch selector type to Athena::RootNtupleEventSelector
     m_evtSelect.setTypeAndName("Athena::RootNtupleEventSelector/"+m_evtSelect.name());
     //also default to 'CollectionTree' as the tree to read
     this->setEvtSelProperty("TupleName","CollectionTree");
   } else {
     //switch selector type to xAODEventSelector:
     m_evtSelect.setTypeAndName("Athena::xAODEventSelector/"+m_evtSelect.name());
   }
 
   //check if a SelectorType has been specified in the joSvc 
   //should retire this code at some point (hangover from basicxAOD.opts)
   if (m_joSvc->has("TEvent.EventSelectorType")) {
     m_evtSelect.setTypeAndName(m_joSvc->get("TEvent.EventSelectorType") + "/" + m_evtSelect.name());
   }
 
   AAH::setProperty( m_evtLoop , "ClearStorePolicy", "BeginEvent" ).ignore();    //for interactive use of storegate
   AAH::setProperty( m_evtLoop , "EvtSel", m_evtSelect.typeAndName() ).ignore(); //connect loop to selector
   AAH::setProperty( m_evtLoop , "EvtStore", m_evtStore.typeAndName() ).ignore();//connect loop to store
   AAH::setProperty( m_evtLoop , "EventPrintoutInterval", 0 ).ignore(); //disable printout (speeds up loop)
 
   if(m_evtSelect.type()=="Athena::xAODEventSelector") {
     AAH::setProperty( m_evtSelect , "ReadMetaDataWithPool" , true).ignore(); //uses hybrid xAOD reading by default
     AAH::setProperty( m_evtSelect , "AccessMode" , int(mode) ).ignore(); //sets the mode
     AAH::setProperty( m_evtSelect , "EvtStore" , m_evtStore.typeAndName() ).ignore();
     //FIXME ... cant get dual event stores working :-(
     //AAH::setProperty( m_evtSelect , "ProxyProviderSvc" , "ProxyProviderSvc/" + name + "_ProxyProviderSvc" );
     //AAH::setProperty( m_evtStore , "ProxyProviderSvc", "ProxyProviderSvc/" + name + "_ProxyProviderSvc" );
   }
 
   //set outputlevels to WARNING 
   AAH::setProperty( m_evtLoop, "OutputLevel", 4 ).ignore();
   AAH::setProperty( m_evtSelect, "OutputLevel", 4 ).ignore();
   //AAH::setProperty( m_evtStore, "OutputLevel", 4 ).ignore();
 
   //suppress messages below WARNING too
   //do this here to stop some pre initialize INFO messages from showing
   ServiceHandle<IProperty> messageSvc("MessageSvc","");
   std::vector<std::string> p;
   Gaudi::Parsers::parse(p,messageSvc->getProperty("setWarning").toString()).ignore();
   p.push_back( m_evtLoop.name() );
   p.push_back( m_evtSelect.name() );
   p.push_back( m_evtStore.name() );
   messageSvc->setProperty(  StringArrayProperty( "setWarning" , p ) ).ignore();
   
   //also push this into the joboptionsvc so that if a reinit happens then these settings are remembered 
   //m_joSvc->addPropertyToCatalogue( "MessageSvc", StringArrayProperty( "setWarning", p ) );
   
}

◆ ~TEvent()

POOL::TEvent::~TEvent ( )

Definition at line 33 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                {
  //need to destroy my storegate, selector, and loop
  if(m_evtLoop.isSet()) {
    m_evtLoop.release().ignore();
  }
  if(m_evtSelect.isSet()) {
    m_evtSelect.release().ignore();
  }
  if(m_evtStore.isSet()) {
    m_evtStore.release().ignore();
  }
}

Member Function Documentation

◆ contains()

PyObject * POOL::TEvent::contains	(	PyObject *	tp,
		PyObject *	pykey )

Definition at line 212 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                                            {
    return AthenaInternal::py_sg_contains( &*evtStore() , tp,  pykey );
  }

◆ evtLoop()

ServiceHandle< IEventSeek > & POOL::TEvent::evtLoop ( )

inline

Definition at line 59 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

59{ return m_evtLoop; }

◆ evtStore()

ServiceHandle< StoreGateSvc > & POOL::TEvent::evtStore ( )

inline

Definition at line 60 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

60{ return m_evtStore; }

◆ get_item()

PyObject * POOL::TEvent::get_item ( PyObject * pykey )

Definition at line 209 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                             {
    return AthenaInternal::py_sg_getitem( &*evtStore() , pykey );
  }

◆ getEntries()

long POOL::TEvent::getEntries ( )

Definition at line 124 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                        {
   if(m_size>=0) return m_size;
   if(!m_evtLoop.isSet()) { if(m_evtLoop.retrieve().isFailure()) return 0; }
   if (ICollectionSize* isize = dynamic_cast<ICollectionSize*>(&*m_evtLoop)) {
     return isize->size();
   }
   return 0;
}

◆ getEntry()

int POOL::TEvent::getEntry ( long entry )

Definition at line 185 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                 {
   if(!m_evtLoop.isSet()) { if(m_evtLoop.retrieve().isFailure()) return -1; }
   if(entry==0 || entry != m_curEntry+1) {
     //need to seek on first read or if not reading next event
     if (m_evtLoop->seek(entry).isFailure()) return -1;
   }
   //ensure our storegate is the active store
   setActive();
   if (m_evtProcessor == nullptr) {
     m_evtProcessor = dynamic_cast<IEventProcessor*>(&*m_evtLoop);
   }
   StatusCode out = m_evtProcessor->nextEvent(entry+1);
   m_curEntry = entry;
   m_incSvc->fireIncident(Incident("BeginEvent",IncidentType::BeginEvent));
   return (out.isSuccess()) ? 0 : -1;
}

◆ Init()

IAppMgrUI * POOL::TEvent::Init ( const char * options = "POOLRootAccess/basic.opts" )

inlinestatic

Definition at line 51 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

51{ return POOL::Init(options); }

POOL::Init

IAppMgrUI * Init(const char *options="POOLRootAccess/basic.opts")

Bootstraps (creates and configures) the Gaudi Application with the provided options file.

Definition PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx:29

◆ inputMetaStore()

ServiceHandle< StoreGateSvc > & POOL::TEvent::inputMetaStore ( )

inline

Definition at line 61 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

61{ return m_inputMetaStore; }

◆ readFrom() [1/3]

StatusCode POOL::TEvent::readFrom ( const char * file )

Definition at line 138 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                              {
   if(m_curEntry >= 0) {
      std::cout << "Unable to change file after already reading" << std::endl;
      return StatusCode::FAILURE;
   }
   std::vector<std::string> myFiles;
   //see if contains wildcard
   //separate by comma
   TString sFileIn(file);
   std::unique_ptr<TObjArray> sFiles(sFileIn.Tokenize(","));
   std::unique_ptr<TIterator> itr(sFiles->MakeIterator());
   TObject* obj;
   while( (obj = itr->Next()) ) {
     TString sFile(static_cast<TObjString*>(obj)->String());
     if(sFile.Contains('*')) {
      std::unique_ptr<TObjArray> theFiles(gSystem->GetFromPipe(("ls " + std::string(file)).c_str()).Tokenize("\n"));
      for(int i=0;i<theFiles->GetEntries();i++) {
         //std::cout << "Adding " << dynamic_cast<TObjString*>(theFiles->At(i))->String().Data() << std::endl;
        if (TObjString* objstr = dynamic_cast<TObjString*>(theFiles->At(i))) {
          myFiles.push_back(gSystem->ExpandPathName(objstr->String().Data()));
        }
      }
     } else {
       myFiles.push_back( gSystem->ExpandPathName(sFile.Data()) );
     }
   }
 
   return AAH::setProperty( m_evtSelect , "InputCollections" , myFiles );
}

◆ readFrom() [2/3]

StatusCode POOL::TEvent::readFrom ( TChain * files )

Definition at line 168 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                         {
 
  //add all files to the property list by giving a comma separated list of files
  std::string sfiles;
  std::unique_ptr<TIterator> itr(files->GetListOfFiles()->MakeIterator());
  TObject* obj;
  bool hasFile(false);
  while( (obj = itr->Next()) ) {
    if(hasFile) sfiles += ",";
    sfiles += obj->GetTitle();
    hasFile=true;
  }
  //std::cout << sfiles << std::endl;
  return readFrom(sfiles.c_str());
 
}

◆ readFrom() [3/3]

StatusCode POOL::TEvent::readFrom ( TFile * file )

Definition at line 133 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                         {
   if(file==0 || file->IsZombie()) return StatusCode::FAILURE;
   return readFrom( file->GetName() );
}

◆ record()

PyObject * POOL::TEvent::record	(	PyObject *	obj,
		PyObject *	pykey,
		bool	allowMods = true,
		bool	resetOnly = true,
		bool	noHist = false )

Definition at line 219 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                                                                                     {
    return AthenaInternal::recordObjectToStore( &*evtStore() , obj, pykey,allowMods,resetOnly,noHist );
  }

◆ retrieve() [1/5]

template<typename T>

StatusCode POOL::TEvent::retrieve ( const T *& obj )

inline

Definition at line 74 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

                                                                   {
            return evtStore()->retrieve( obj );
         }

◆ retrieve() [2/5]

template<typename T>

StatusCode POOL::TEvent::retrieve	(	const T *&	obj,
		const std::string &	key )

inline

Definition at line 82 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

                                                                                         {
            return evtStore()->retrieve( obj, key );
         }

◆ retrieve() [3/5]

PyObject * POOL::TEvent::retrieve	(	PyObject *	tp,
		PyObject *	pykey )

retrieve and record method for python

Definition at line 204 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

 {
   return AthenaInternal::retrieveObjectFromStore( &*evtStore() , tp, pykey );
 }

◆ retrieve() [4/5]

template<typename T>

StatusCode POOL::TEvent::retrieve ( T *& obj )

inline

Definition at line 78 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

                                                             {
            return evtStore()->retrieve( obj );
         }

◆ retrieve() [5/5]

template<typename T>

StatusCode POOL::TEvent::retrieve	(	T *&	obj,
		const std::string &	key )

inline

Definition at line 85 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

                                                                                   {
            return evtStore()->retrieve( obj, key );
         }

◆ retrieveMetaInput() [1/2]

template<typename T>

StatusCode POOL::TEvent::retrieveMetaInput	(	const T *&	obj,
		const std::string &	key )

inline

Definition at line 90 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

                                                                                                  {
            return inputMetaStore()->retrieve( obj, key );
         }

◆ retrieveMetaInput() [2/2]

PyObject * POOL::TEvent::retrieveMetaInput	(	PyObject *	tp,
		PyObject *	pykey )

Definition at line 215 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                                                                   {
    if(!m_evtLoop.isSet()) { if(m_evtLoop.retrieve().isFailure()) return 0; }
    return AthenaInternal::retrieveObjectFromStore( &*inputMetaStore() , tp, pykey );
  }

◆ setActive()

void POOL::TEvent::setActive ( )

ensure we are the active store, for the purpose of element links etc

Definition at line 120 of file PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx.

                       {
    m_evtStore->makeCurrent();
}

◆ setEvtSelProperty()

template<typename T>

void POOL::TEvent::setEvtSelProperty	(	const char *	name,
		const T &	val )

inline

Definition at line 63 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

                                                                                       {
            if constexpr (std::is_convertible_v<T, std::string>) {
               // Gaudi::Utils::toString adds extra quotes, don't do this for strings:
               m_joSvc->set(m_evtSelect.name() + "." + name, std::string(val));
            }
            else {
               m_joSvc->set(m_evtSelect.name() + "." + name, Gaudi::Utils::toString(val));
            }
         }

Member Data Documentation

◆ m_curEntry

long POOL::TEvent::m_curEntry = -1

private

Definition at line 113 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_evtLoop

ServiceHandle<IEventSeek> POOL::TEvent::m_evtLoop

private

Definition at line 121 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_evtProcessor

IEventProcessor* POOL::TEvent::m_evtProcessor

private

Definition at line 116 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_evtSelect

ServiceHandle<IEvtSelectorSeek> POOL::TEvent::m_evtSelect

private

Definition at line 122 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_evtStore

ServiceHandle<StoreGateSvc> POOL::TEvent::m_evtStore

private

Definition at line 123 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_incSvc

ServiceHandle<IIncidentSvc> POOL::TEvent::m_incSvc

private

Definition at line 118 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_inputMetaStore

ServiceHandle<StoreGateSvc> POOL::TEvent::m_inputMetaStore

private

Definition at line 125 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_joSvc

ServiceHandle<Gaudi::Interfaces::IOptionsSvc> POOL::TEvent::m_joSvc

private

Definition at line 119 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

◆ m_size

long POOL::TEvent::m_size = -1

private

Definition at line 114 of file PhysicsAnalysis/POOLRootAccess/POOLRootAccess/TEvent.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EReadMode

Constructor & Destructor Documentation

◆ TEvent() [1/2]

◆ TEvent() [2/2]

◆ ~TEvent()

Member Function Documentation

◆ contains()

◆ evtLoop()

◆ evtStore()

◆ get_item()

◆ getEntries()

◆ getEntry()

◆ Init()

◆ inputMetaStore()

◆ readFrom() [1/3]

◆ readFrom() [2/3]

◆ readFrom() [3/3]

◆ record()

◆ retrieve() [1/5]

◆ retrieve() [2/5]

◆ retrieve() [3/5]

◆ retrieve() [4/5]

◆ retrieve() [5/5]

◆ retrieveMetaInput() [1/2]

◆ retrieveMetaInput() [2/2]

◆ setActive()

◆ setEvtSelProperty()

Member Data Documentation

◆ m_curEntry

◆ m_evtLoop

◆ m_evtProcessor

◆ m_evtSelect

◆ m_evtStore

◆ m_incSvc

◆ m_inputMetaStore

◆ m_joSvc

◆ m_size