celeritas::EventReaderInterface Class Reference

Abstract base class for reading all primaries from an event. More...

#include <EventIOInterface.hh>

Inheritance diagram for celeritas::EventReaderInterface:

Public Types
Type aliases
using	VecPrimary = std::vector< Primary >
using	result_type = VecPrimary

Public Member Functions
virtual result_type	operator() ()=0
	Read all primaries from a single event.
virtual size_type	num_events () const =0
	Get total number of events.

Protected Member Functions
	EventReaderInterface (EventReaderInterface const &)=default
EventReaderInterface &	operator= (EventReaderInterface const &)=default
	EventReaderInterface (EventReaderInterface &&)=default
EventReaderInterface &	operator= (EventReaderInterface &&)=default

Detailed Description

Abstract base class for reading all primaries from an event.

Constructor & Destructor Documentation

EventReaderInterface() [1/3]

celeritas::EventReaderInterface::EventReaderInterface ( )

protecteddefault

Allow construction and assignment only through daughter classes

EventReaderInterface() [2/3]

celeritas::EventReaderInterface::EventReaderInterface ( EventReaderInterface const &  )

protecteddefault

Allow construction and assignment only through daughter classes

EventReaderInterface() [3/3]

celeritas::EventReaderInterface::EventReaderInterface ( EventReaderInterface &&  )

protecteddefault

Allow construction and assignment only through daughter classes

Member Function Documentation

num_events()

virtual size_type celeritas::EventReaderInterface::num_events ( ) const

pure virtual

Get total number of events.

Implemented in celeritas::EventReader, celeritas::JsonEventReader, celeritas::RootEventReader, celeritas::RootEventSampler, and celeritas::PrimaryGenerator.

operator()()

virtual result_type celeritas::EventReaderInterface::operator() ( )

pure virtual

Read all primaries from a single event.

Implemented in celeritas::EventReader, celeritas::JsonEventReader, celeritas::RootEventReader, celeritas::PrimaryGenerator, and celeritas::RootEventSampler.

operator=() [1/2]

EventReaderInterface & celeritas::EventReaderInterface::operator= ( EventReaderInterface &&  )

protecteddefault

Allow construction and assignment only through daughter classes

operator=() [2/2]

EventReaderInterface & celeritas::EventReaderInterface::operator= ( EventReaderInterface const &  )

protecteddefault

Allow construction and assignment only through daughter classes

---

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

• EventIOInterface.hh