podio::EventStore Class Reference

#include <EventStore.h>

Inheritance diagram for podio::EventStore:

Public Types
typedef std::pair< std::string, CollectionBase * >	CollPair
	Collection entry. Each collection is identified by a name.
typedef std::vector< CollPair >	CollContainer

Public Member Functions
	EventStore (const EventStore &)=delete
	Make non-copyable.
EventStore &	operator= (const EventStore &)=delete
	EventStore ()
	~EventStore ()
template<typename T >
T &	create (const std::string &name)
	create a new collection
void	registerCollection (const std::string &name, podio::CollectionBase *coll)
	register an existing collection
template<typename T >
bool	get (const std::string &name, const T *&collection)
	access a collection by name. returns true if successful
CollectionBase *	getFast (int id) const
	fast access to cached collections
bool	get (int id, CollectionBase *&coll) const final
	access a collection by ID. returns true if successful
template<typename T >
const T &	get (const std::string &name)
void	clearCollections ()
	empties collections.
void	clear ()
	clears itself; deletes collections (use at end of event processing)
void	clearCaches ()
	Clears only the cache containers (use at end of event if ownership of read objects is transferred)
void	setReader (IReader *reader)
	set the reader
CollectionIDTable *	getCollectionIDTable () const
virtual bool	isValid () const final
GenericParameters &	getEventMetaData () override
	return the event meta data for the current event
GenericParameters &	getRunMetaData (int runID) override
	return the run meta data for the given runID
GenericParameters &	getCollectionMetaData (int colID) override
	return the collection meta data for the given colID
RunMDMap *	getRunMetaDataMap ()
ColMDMap *	getColMetaDataMap ()
GenericParameters *	eventMetaDataPtr ()
Public Member Functions inherited from podio::ICollectionProvider
virtual	~ICollectionProvider ()=default
	destructor
virtual bool	get (int collectionID, CollectionBase *&collection) const =0
	access a collection by ID. returns true if successful
Public Member Functions inherited from podio::IMetaDataProvider
virtual	~IMetaDataProvider ()=default
	destructor
virtual GenericParameters &	getEventMetaData ()=0
	return the event meta data for the current event
virtual GenericParameters &	getRunMetaData (int runID)=0
	return the run meta data for the given runID
virtual GenericParameters &	getCollectionMetaData (int colID)=0
	return the collection meta data for the given colID

Detailed Description

Definition at line 37 of file EventStore.h.

Member Typedef Documentation

CollContainer

typedef std::vector<CollPair> podio::EventStore::CollContainer

Definition at line 45 of file EventStore.h.

CollPair

typedef std::pair<std::string, CollectionBase*> podio::EventStore::CollPair

Collection entry. Each collection is identified by a name.

Definition at line 44 of file EventStore.h.

Constructor & Destructor Documentation

EventStore() [1/2]

podio::EventStore::EventStore ( const EventStore &  )

delete

Make non-copyable.

EventStore() [2/2]

podio::EventStore::EventStore

(

)

Definition at line 9 of file EventStore.cc.

                       : m_table(new CollectionIDTable()) {
  m_cachedCollections.resize(128); // allow for a sufficiently large initial number of collections
}

~EventStore()

podio::EventStore::~EventStore

(

)

Definition at line 13 of file EventStore.cc.

                        {
  for (auto& coll : m_collections) {
    delete coll.second;
  }
}

Member Function Documentation

clear()

void podio::EventStore::clear

(

)

clears itself; deletes collections (use at end of event processing)

Definition at line 126 of file EventStore.cc.

                       {
  for (auto& coll : m_collections) {
    coll.second->clear();
    delete coll.second;
  }
 
  m_evtMD.clear();
  clearCaches();
}

Referenced by testWithIO().

clearCaches()

void podio::EventStore::clearCaches

(

)

Clears only the cache containers (use at end of event if ownership of read objects is transferred)

Definition at line 136 of file EventStore.cc.

                             {
  m_collections.clear();
  m_cachedCollections.clear();
  m_cachedCollections.resize(128);
  m_retrievedIDs.clear();
}

Referenced by clear().

clearCollections()

void podio::EventStore::clearCollections

(

)

empties collections.

Definition at line 119 of file EventStore.cc.

                                  {
  for (auto& coll : m_collections) {
    coll.second->clear();
  }
  m_evtMD.clear();
}

Referenced by testWithIO(), and write().

create()

template<typename T >

T & podio::EventStore::create

(

const std::string &

name

)

create a new collection

Definition at line 133 of file EventStore.h.

                                           {
  static_assert(std::is_base_of<podio::CollectionBase, T>::value,
                "DataStore only accepts types inheriting from CollectionBase");
  // TODO: add check for existence
  T* coll = new T();
  registerCollection(name, coll);
  return *coll;
}

Referenced by testWithIO(), and write().

eventMetaDataPtr()

GenericParameters * podio::EventStore::eventMetaDataPtr ( )

inline

Definition at line 107 of file EventStore.h.

                                        {
    return &m_evtMD;
  }

Referenced by podio::ROOTWriter::ROOTWriter(), and podio::SIOWriter::SIOWriter().

get() [1/3]

template<typename T >

const T & podio::EventStore::get

(

const std::string &

name

)

access a collection by name returns a collection w/ setting isValid to true if successful

Definition at line 156 of file EventStore.h.

                                              {
  const T* tmp(0);
  auto success = this->get(name, tmp);
  if (!success) {
    throw std::runtime_error("No collection \'" + name + "\' is present in the EventStore");
  }
  return *tmp;
}

get() [2/3]

template<typename T >

bool podio::EventStore::get	(	const std::string &	name,
		const T *&	collection
	)

access a collection by name. returns true if successful

Definition at line 143 of file EventStore.h.

                                                                {
  //  static_assert(std::is_base_of<podio::CollectionBase,T>::value,
  //              "DataStore only contains types inheriting from CollectionBase");
  CollectionBase* tmp{nullptr};
  doGet(name, tmp);
  collection = static_cast<T*>(tmp);
  if (collection != nullptr) {
    return true;
  }
  return false;
}

Referenced by podio::ROOTWriter::finish(), get(), podio::ASCIIWriter::registerForWrite(), podio::ROOTWriter::registerForWrite(), podio::SIOWriter::registerForWrite(), podio::SIOCollectionIDTableBlock::SIOCollectionIDTableBlock(), testWithIO(), and podio::ROOTWriter::writeEvent().

get() [3/3]

bool podio::EventStore::get ( int  id, CollectionBase *&  coll  ) const

finalvirtual

access a collection by ID. returns true if successful

Implements podio::ICollectionProvider.

Definition at line 19 of file EventStore.cc.

                                                              {
  // see if we have a cached collection
  if ((collection = getFast(id)) != nullptr) {
    return true;
  }
 
  auto val = m_retrievedIDs.insert(id);
  bool success = false;
  if (val.second == true) {
    // collection not yet retrieved in recursive-call
    auto name = m_table->name(id);
    success = doGet(name, collection, true);
    if (collection != nullptr) { // cache the collection for faster retreaval later
      if (m_cachedCollections.size() < (unsigned)id + 1) {
        m_cachedCollections.resize(id + 1);
      }
      m_cachedCollections[id] = collection;
    }
  } else {
    // collection already requested in recursive call
    // do not set the references to break collection dependency-cycle
    auto name = m_table->name(id);
    success = doGet(name, collection, false);
  }
  // fg: the set should only be cleared at the end of event (in clear() ) ...
  //    m_retrievedIDs.erase(id);
  return success;
}

getCollectionIDTable()

CollectionIDTable * podio::EventStore::getCollectionIDTable ( ) const

inline

Definition at line 86 of file EventStore.h.

                                                  {
    return m_table.get();
  }

Referenced by podio::ROOTWriter::finish(), and podio::SIOCollectionIDTableBlock::SIOCollectionIDTableBlock().

getCollectionMetaData()

GenericParameters & podio::EventStore::getCollectionMetaData ( int  colID )

overridevirtual

return the collection meta data for the given colID

Implements podio::IMetaDataProvider.

Definition at line 109 of file EventStore.cc.

                                                              {
 
  if (m_colMDMap.empty() && m_reader != nullptr) {
    ColMDMap* tmp = m_reader->readCollectionMetaData();
    m_colMDMap = std::move(*tmp);
    delete tmp;
  }
  return m_colMDMap[colID];
}

Referenced by write().

getColMetaDataMap()

ColMDMap * podio::EventStore::getColMetaDataMap ( )

inline

Definition at line 104 of file EventStore.h.

                                {
    return &m_colMDMap;
  }

Referenced by podio::ROOTWriter::finish(), and podio::SIOWriter::SIOWriter().

getEventMetaData()

GenericParameters & podio::EventStore::getEventMetaData ( )

overridevirtual

return the event meta data for the current event

Implements podio::IMetaDataProvider.

Definition at line 89 of file EventStore.cc.

                                                {
 
  if (m_evtMD.empty() && m_reader != nullptr) {
    GenericParameters* tmp = m_reader->readEventMetaData();
    m_evtMD = std::move(*tmp);
    delete tmp;
  }
  return m_evtMD;
}

Referenced by write().

getFast()

CollectionBase * podio::EventStore::getFast ( int  id ) const

inline

fast access to cached collections

Definition at line 62 of file EventStore.h.

                                        {
    return (m_cachedCollections.size() > (unsigned)id ? m_cachedCollections[id] : nullptr);
  }

Referenced by get().

getRunMetaData()

GenericParameters & podio::EventStore::getRunMetaData ( int  runID )

overridevirtual

return the run meta data for the given runID

Implements podio::IMetaDataProvider.

Definition at line 99 of file EventStore.cc.

                                                       {
 
  if (m_runMDMap.empty() && m_reader != nullptr) {
    RunMDMap* tmp = m_reader->readRunMetaData();
    m_runMDMap = std::move(*tmp);
    delete tmp;
  }
  return m_runMDMap[runID];
}

getRunMetaDataMap()

RunMDMap * podio::EventStore::getRunMetaDataMap ( )

inline

Definition at line 101 of file EventStore.h.

                                {
    return &m_runMDMap;
  }

Referenced by podio::ROOTWriter::finish(), and podio::SIOWriter::SIOWriter().

isValid()

bool podio::EventStore::isValid ( ) const

finalvirtual

Definition at line 54 of file EventStore.cc.

                               {
  return m_reader->isValid();
}

operator=()

EventStore & podio::EventStore::operator= ( const EventStore &  )

delete

registerCollection()

void podio::EventStore::registerCollection	(	const std::string &	name,
		podio::CollectionBase *	coll
	)

register an existing collection

Definition at line 48 of file EventStore.cc.

                                                                                    {
  m_collections.push_back({name, coll});
  auto id = m_table->add(name);
  coll->setID(id);
}

Referenced by create().

setReader()

void podio::EventStore::setReader

(

IReader *

reader

)

set the reader

Definition at line 149 of file EventStore.cc.

                                          {
  m_reader = reader;
  setCollectionIDTable(reader->getCollectionIDTable());
}

Referenced by podio::PythonEventStore::PythonEventStore(), and testWithIO().

---

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

• EventStore.h
• EventStore.cc