ActsExamples::IReader Class Reference

#include <acts/blob/sPHENIX/Examples/Framework/include/ActsExamples/Framework/IReader.hpp>

Inheritance diagram for ActsExamples::IReader:

Public Member Functions
virtual	~IReader ()=default
virtual std::string	name () const =0
	The reader name.
virtual std::pair< size_t, size_t >	availableEvents () const =0
virtual ProcessCode	read (const AlgorithmContext &context)=0

Detailed Description

Event data reader interface.

Read data from disk and add it to the event store. The reader can have internal state and implementations are responsible to handle concurrent calls.

Definition at line 24 of file IReader.hpp.

View newest version in sPHENIX GitHub at line 24 of file IReader.hpp

Constructor & Destructor Documentation

virtual ActsExamples::IReader::~IReader ( )

virtualdefault

Member Function Documentation

virtual std::pair<size_t, size_t> ActsExamples::IReader::availableEvents ( ) const

pure virtual

Provide range of available events or [0, SIZE_MAX) if undefined.

The upper limit is exclusive, i.e. [0,3) means events 0, 1, and 2.

Implemented in ActsExamples::EventGenerator, ActsExamples::RootMaterialTrackReader, ActsExamples::CsvPlanarClusterReader, and ActsExamples::CsvParticleReader.

virtual std::string ActsExamples::IReader::name ( ) const

pure virtual

The reader name.

Implemented in ActsExamples::EventGenerator, ActsExamples::RootMaterialTrackReader, ActsExamples::CsvPlanarClusterReader, and ActsExamples::CsvParticleReader.

Referenced by eicpy.verify.PythiaHistograms::__init__(), and eicpy.verify.DjangohHistograms::__init__().

Here is the caller graph for this function:

virtual ProcessCode ActsExamples::IReader::read ( const AlgorithmContext &  context )

pure virtual

Read data for the requested event and write it into the event store.

As a result of the parallelization and/or skipping events, this method will most likely not be called in order. Implementations must use the event number provided to select the proper data to be read.

Implemented in ActsExamples::RootMaterialTrackReader, ActsExamples::EventGenerator, ActsExamples::CsvPlanarClusterReader, and ActsExamples::CsvParticleReader.

---

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

• acts/blob/sPHENIX/Examples/Framework/include/ActsExamples/Framework/IReader.hpp