celeritas::RootEventReader Class Reference

Read ROOT file generated by RootEventWriter . More...

#include <RootEventReader.hh>

Inheritance diagram for celeritas::RootEventReader:

Public Types
Type aliases
using	SPConstParticles = std::shared_ptr< ParticleParams const >
using	result_type = std::vector< Primary >
Public Types inherited from celeritas::EventReaderInterface
using	VecPrimary = std::vector< Primary >
using	result_type = VecPrimary

Public Member Functions
	RootEventReader (std::string const &filename, SPConstParticles params)
	Construct with ROOT input filename.
	RootEventReader (RootEventReader const &)=delete
	Prevent copying and moving.
RootEventReader &	operator= (RootEventReader const &)=delete
	RootEventReader (RootEventReader &&)=delete
RootEventReader &	operator= (RootEventReader &&)=delete
result_type	operator() (EventId event_id)
	Read a specific single event from the primaries tree.
result_type	operator() () final
	Read single event from the primaries tree.
size_type	num_events () const final
	Get total number of events.

Additional Inherited Members
Protected Member Functions inherited from celeritas::EventReaderInterface
	EventReaderInterface (EventReaderInterface const &)=default
EventReaderInterface &	operator= (EventReaderInterface const &)=default
	EventReaderInterface (EventReaderInterface &&)=default
EventReaderInterface &	operator= (EventReaderInterface &&)=default

Detailed Description

Read ROOT file generated by RootEventWriter .

Each operator() call returns a vector of primaries from a single event.

RootEventReader read("primaries.root", particle_params);
RootEventReader::result_type event;
while (event = read(), !event.empty())
{
    // Do stuff
}

Member Function Documentation

num_events()

size_type celeritas::RootEventReader::num_events ( ) const

inlinefinalvirtual

Get total number of events.

Implements celeritas::EventReaderInterface.

operator()()

RootEventReader::result_type celeritas::RootEventReader::operator() ( )

inlinefinalvirtual

Read single event from the primaries tree.

Implements celeritas::EventReaderInterface.

---

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

• RootEventReader.hh
• RootEventReader.cc