eic-smear  1.0.3
A collection of ROOT classes for Monte Carlo events and a fast-smearing code simulating detector effects for the Electron-Ion Collider task force
erhic::LogReader Class Referenceabstract

Base class for log file processors. More...

#include <File.h>

Inheritance diagram for erhic::LogReader:
erhic::LogReaderDjangoh erhic::LogReaderGmcTrans erhic::LogReaderMilou erhic::LogReaderPepsi erhic::LogReaderPythia

Public Member Functions

 LogReader ()
 Constructor. More...
 
virtual ~LogReader ()
 Destructor. More...
 
virtual LogReaderCreate () const =0
 Return a new LogReader instance. More...
 
virtual bool Extract (const std::string &file)=0
 Extract data from the named log file. More...
 
virtual Int_t Save () const =0
 Saves the extracted data to the current file, if one is open and is writeable. More...
 

Detailed Description

Base class for log file processors.

Reads a log file from a Monte Carlo generator and extracts information. Inherited classes for each generator type implement the Extract() method to gather the required information for that generator and the Save() method to store it to file.

Definition at line 36 of file File.h.

Constructor & Destructor Documentation

◆ LogReader()

erhic::LogReader::LogReader ( )
inline

Constructor.

Definition at line 41 of file File.h.

◆ ~LogReader()

virtual erhic::LogReader::~LogReader ( )
inlinevirtual

Destructor.

Definition at line 46 of file File.h.

Member Function Documentation

◆ Create()

virtual LogReader* erhic::LogReader::Create ( ) const
pure virtual

◆ Extract()

virtual bool erhic::LogReader::Extract ( const std::string &  file)
pure virtual

◆ Save()

virtual Int_t erhic::LogReader::Save ( ) const
pure virtual

Saves the extracted data to the current file, if one is open and is writeable.

Returns -1 if the data cannot be saved. To write the LogReader itself, use LogReader::Write().

Implemented in erhic::LogReaderGmcTrans, erhic::LogReaderMilou, erhic::LogReaderDjangoh, erhic::LogReaderPepsi, and erhic::LogReaderPythia.


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