podio::TimedReader< WrappedReader > Class Template Reference

#include <TimedReader.h>

Inheritance diagram for podio::TimedReader< WrappedReader >:

Public Member Functions
template<typename... Args>
	TimedReader (benchmark::BenchmarkRecorder &recorder, Args &&... args)
	~TimedReader ()
CollectionBase *	readCollection (const std::string &name) override
std::shared_ptr< CollectionIDTable >	getCollectionIDTable () override
	Get CollectionIDTable of read-in data.
GenericParameters *	readEventMetaData () override
	read event meta data from file
std::map< int, GenericParameters > *	readCollectionMetaData () override
std::map< int, GenericParameters > *	readRunMetaData () override
unsigned	getEntries () const override
	get the number of events available from this reader
void	endOfEvent () override
	Prepare the reader to read the next event.
bool	isValid () const override
	Check if reader is valid.
void	openFile (const std::string &filename) override
void	closeFile () override
void	readEvent () override
void	goToEvent (unsigned ev) override
podio::version::Version	currentFileVersion () const override
	Get the podio version with which the current file has been written.
Public Member Functions inherited from podio::IReader
virtual	~IReader ()=default
virtual CollectionBase *	readCollection (const std::string &name)=0
virtual std::shared_ptr< CollectionIDTable >	getCollectionIDTable ()=0
	Get CollectionIDTable of read-in data.
virtual GenericParameters *	readEventMetaData ()=0
	read event meta data from file
virtual std::map< int, GenericParameters > *	readCollectionMetaData ()=0
virtual std::map< int, GenericParameters > *	readRunMetaData ()=0
virtual unsigned	getEntries () const =0
	get the number of events available from this reader
virtual void	endOfEvent ()=0
	Prepare the reader to read the next event.
virtual bool	isValid () const =0
	Check if reader is valid.
virtual void	openFile (const std::string &filename)=0
virtual void	closeFile ()=0
virtual void	readEvent ()=0
virtual void	goToEvent (unsigned iEvent)=0
virtual podio::version::Version	currentFileVersion () const =0
	Get the podio version with which the current file has been written.

Detailed Description

template<class WrappedReader>
class podio::TimedReader< WrappedReader >

Definition at line 15 of file TimedReader.h.

Constructor & Destructor Documentation

TimedReader()

template<class WrappedReader >

template<typename... Args>

podio::TimedReader< WrappedReader >::TimedReader ( benchmark::BenchmarkRecorder &  recorder, Args &&...  args  )

inline

Definition at line 20 of file TimedReader.h.

                                                                    :
      m_start(ClockT::now()),
      m_reader(WrappedReader(std::forward<Args>(args)...)),
      m_end(ClockT::now()),
      m_recorder(recorder),
      m_perEventTree(m_recorder.addTree(
          "event_times",
          {"read_collections", "read_ev_md", "read_run_md", "read_coll_md", "end_of_event", "read_event"})) {
    m_recorder.addTree("setup_times", {"constructor", "open_file", "close_file", "read_collection_ids", "get_entries"});
    m_recorder.recordTime("setup_times", "constructor", m_end - m_start);
  }

~TimedReader()

template<class WrappedReader >

podio::TimedReader< WrappedReader >::~TimedReader ( )

inline

Definition at line 32 of file TimedReader.h.

                 {
    // Timing deconstructors is not straight forward when wrapping a value.
    // Since nothing is usually happening in them in any case, we simply don't
    // do it. We still have to fill the setup_times tree here though.
    m_recorder.Fill("setup_times");
  }

Member Function Documentation

closeFile()

template<class WrappedReader >

void podio::TimedReader< WrappedReader >::closeFile ( )

inlineoverridevirtual

Implements podio::IReader.

Definition at line 90 of file TimedReader.h.

                            {
    runVoidTimed(false, "close_file", &IReader::closeFile);
  }

Referenced by main().

currentFileVersion()

template<class WrappedReader >

podio::version::Version podio::TimedReader< WrappedReader >::currentFileVersion ( ) const

inlineoverridevirtual

Get the podio version with which the current file has been written.

Implements podio::IReader.

Definition at line 103 of file TimedReader.h.

                                                          {
    // no need to time this as it is really just a very simple get
    return m_reader.currentFileVersion();
  }

endOfEvent()

template<class WrappedReader >

void podio::TimedReader< WrappedReader >::endOfEvent ( )

inlineoverridevirtual

Prepare the reader to read the next event.

Implements podio::IReader.

Definition at line 73 of file TimedReader.h.

                             {
    runVoidTimed(true, "end_of_event", &IReader::endOfEvent);
 
    m_perEventTree.recordTime("read_collections", m_totalCollectionReadTime);
    m_perEventTree.Fill();
    m_totalCollectionReadTime = std::chrono::nanoseconds{0};
  }

getCollectionIDTable()

template<class WrappedReader >

std::shared_ptr< CollectionIDTable > podio::TimedReader< WrappedReader >::getCollectionIDTable ( )

inlineoverridevirtual

Get CollectionIDTable of read-in data.

Implements podio::IReader.

Definition at line 50 of file TimedReader.h.

                                                                   {
    return runTimed(false, "read_collection_ids", &IReader::getCollectionIDTable);
  }

getEntries()

template<class WrappedReader >

unsigned podio::TimedReader< WrappedReader >::getEntries ( ) const

inlineoverridevirtual

get the number of events available from this reader

Implements podio::IReader.

Definition at line 68 of file TimedReader.h.

                                       {
    return runTimed(false, "get_entries", &IReader::getEntries);
  }

goToEvent()

template<class WrappedReader >

void podio::TimedReader< WrappedReader >::goToEvent ( unsigned  ev )

inlineoverridevirtual

Implements podio::IReader.

Definition at line 98 of file TimedReader.h.

                                       {
    // TODO: Do we need to time this? Not really used at the moment
    m_reader.goToEvent(ev);
  }

isValid()

template<class WrappedReader >

bool podio::TimedReader< WrappedReader >::isValid ( ) const

inlineoverridevirtual

Check if reader is valid.

Implements podio::IReader.

Definition at line 82 of file TimedReader.h.

                                {
    return m_reader.isValid();
  }

openFile()

template<class WrappedReader >

void podio::TimedReader< WrappedReader >::openFile ( const std::string &  filename )

inlineoverridevirtual

Implements podio::IReader.

Definition at line 86 of file TimedReader.h.

                                                    {
    runVoidTimed(false, "open_file", &IReader::openFile, filename);
  }

Referenced by main().

readCollection()

template<class WrappedReader >

CollectionBase * podio::TimedReader< WrappedReader >::readCollection ( const std::string &  name )

inlineoverridevirtual

Read Collection of given name Does not set references yet.

Implements podio::IReader.

Definition at line 41 of file TimedReader.h.

                                                                 {
    const auto [result, duration] = benchmark::run_member_timed(m_reader, &IReader::readCollection, name);
    // since we cannot in general know how many collections there will be read
    // we simply sum up all the requests in an event and record that
    m_totalCollectionReadTime += duration;
    return result;
  }

readCollectionMetaData()

template<class WrappedReader >

std::map< int, GenericParameters > * podio::TimedReader< WrappedReader >::readCollectionMetaData ( )

inlineoverridevirtual

Implements podio::IReader.

Definition at line 59 of file TimedReader.h.

                                                                    {
    return runTimed(true, "read_coll_md", &IReader::readCollectionMetaData);
  }

readEvent()

template<class WrappedReader >

void podio::TimedReader< WrappedReader >::readEvent ( )

inlineoverridevirtual

Implements podio::IReader.

Definition at line 94 of file TimedReader.h.

                            {
    runVoidTimed(true, "read_event", &IReader::readEvent);
  }

readEventMetaData()

template<class WrappedReader >

GenericParameters * podio::TimedReader< WrappedReader >::readEventMetaData ( )

inlineoverridevirtual

read event meta data from file

Implements podio::IReader.

Definition at line 55 of file TimedReader.h.

                                                  {
    return runTimed(true, "read_ev_md", &IReader::readEventMetaData);
  }

readRunMetaData()

template<class WrappedReader >

std::map< int, GenericParameters > * podio::TimedReader< WrappedReader >::readRunMetaData ( )

inlineoverridevirtual

Implements podio::IReader.

Definition at line 63 of file TimedReader.h.

                                                             {
    return runTimed(true, "read_run_md", &IReader::readRunMetaData);
  }

---

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

• TimedReader.h