podio::IReader Class Reference

#include <IReader.h>

Inheritance diagram for podio::IReader:

Public Member Functions
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

Definition at line 26 of file IReader.h.

Constructor & Destructor Documentation

~IReader()

virtual podio::IReader::~IReader ( )

virtualdefault

Member Function Documentation

closeFile()

virtual void podio::IReader::closeFile ( )

pure virtual

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by podio::TimedReader< WrappedReader >::closeFile().

currentFileVersion()

virtual podio::version::Version podio::IReader::currentFileVersion ( ) const

pure virtual

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

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by run_read_test(), and run_read_test_event().

endOfEvent()

virtual void podio::IReader::endOfEvent ( )

pure virtual

Prepare the reader to read the next event.

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by podio::TimedReader< WrappedReader >::endOfEvent(), run_read_test(), and run_read_test_event().

getCollectionIDTable()

virtual std::shared_ptr< CollectionIDTable > podio::IReader::getCollectionIDTable ( )

pure virtual

Get CollectionIDTable of read-in data.

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by podio::TimedReader< WrappedReader >::getCollectionIDTable(), and podio::EventStore::setReader().

getEntries()

virtual unsigned podio::IReader::getEntries ( ) const

pure virtual

get the number of events available from this reader

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by podio::TimedReader< WrappedReader >::getEntries(), and run_read_test().

goToEvent()

virtual void podio::IReader::goToEvent ( unsigned  iEvent )

pure virtual

Implemented in podio::TimedReader< WrappedReader >, podio::ROOTReader, and podio::SIOReader.

Referenced by run_read_test_event().

isValid()

virtual bool podio::IReader::isValid ( ) const

pure virtual

Check if reader is valid.

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by podio::EventStore::isValid().

openFile()

virtual void podio::IReader::openFile ( const std::string &  filename )

pure virtual

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by podio::TimedReader< WrappedReader >::openFile().

readCollection()

virtual CollectionBase * podio::IReader::readCollection ( const std::string &  name )

pure virtual

Read Collection of given name Does not set references yet.

Implemented in podio::TimedReader< WrappedReader >.

Referenced by podio::TimedReader< WrappedReader >::readCollection().

readCollectionMetaData()

virtual std::map< int, GenericParameters > * podio::IReader::readCollectionMetaData ( )

pure virtual

Implemented in podio::TimedReader< WrappedReader >.

Referenced by podio::EventStore::getCollectionMetaData(), and podio::TimedReader< WrappedReader >::readCollectionMetaData().

readEvent()

virtual void podio::IReader::readEvent ( )

pure virtual

Implemented in podio::ROOTReader, podio::SIOReader, and podio::TimedReader< WrappedReader >.

Referenced by podio::TimedReader< WrappedReader >::readEvent().

readEventMetaData()

virtual GenericParameters * podio::IReader::readEventMetaData ( )

pure virtual

read event meta data from file

Implemented in podio::TimedReader< WrappedReader >.

Referenced by podio::EventStore::getEventMetaData(), and podio::TimedReader< WrappedReader >::readEventMetaData().

readRunMetaData()

virtual std::map< int, GenericParameters > * podio::IReader::readRunMetaData ( )

pure virtual

Implemented in podio::TimedReader< WrappedReader >.

Referenced by podio::EventStore::getRunMetaData(), and podio::TimedReader< WrappedReader >::readRunMetaData().

---

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

• IReader.h