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::LogReaderGmcTrans Class Reference

Processes gmc_trans log files. More...

#include <File.h>

Inheritance diagram for erhic::LogReaderGmcTrans:
erhic::LogReader

Public Member Functions

 LogReaderGmcTrans ()
 Constructor. More...
 
virtual ~LogReaderGmcTrans ()
 Destructor. More...
 
LogReaderGmcTransCreate () const
 Return a new LogReaderGmcTrans instance. More...
 
bool Extract (const std::string &filename)
 Search the named file. More...
 
Int_t Save () const
 Write the stored cross section and number of events to the active ROOT directory. More...
 
Int_t GetNEvents () const
 Returns the number of events reported by the log file. More...
 
Double_t GetCrossSection () const
 Returns the total cross section reported by the log file. More...
 
- Public Member Functions inherited from erhic::LogReader
 LogReader ()
 Constructor. More...
 
virtual ~LogReader ()
 Destructor. More...
 

Protected Attributes

TObjString mNEvents
 Number of generated events. More...
 
TObjString mCrossSection
 Total cross section in microbarns. More...
 

Detailed Description

Processes gmc_trans log files.

Reads a log file and finds the total cross section and the number of generated events.

Definition at line 302 of file File.h.

Constructor & Destructor Documentation

◆ LogReaderGmcTrans()

erhic::LogReaderGmcTrans::LogReaderGmcTrans ( )

Constructor.

Definition at line 297 of file File.cxx.

◆ ~LogReaderGmcTrans()

erhic::LogReaderGmcTrans::~LogReaderGmcTrans ( )
virtual

Destructor.

Definition at line 302 of file File.cxx.

Member Function Documentation

◆ Create()

LogReaderGmcTrans * erhic::LogReaderGmcTrans::Create ( ) const
virtual

Return a new LogReaderGmcTrans instance.

Implements erhic::LogReader.

Definition at line 305 of file File.cxx.

◆ Extract()

bool erhic::LogReaderGmcTrans::Extract ( const std::string &  filename)
virtual

Search the named file.

Store the total cross section and number of generated events if they can be found.

Implements erhic::LogReader.

Definition at line 309 of file File.cxx.

◆ GetCrossSection()

Double_t erhic::LogReaderGmcTrans::GetCrossSection ( ) const

Returns the total cross section reported by the log file.

Extract() should be called first.

Definition at line 356 of file File.cxx.

◆ GetNEvents()

Int_t erhic::LogReaderGmcTrans::GetNEvents ( ) const

Returns the number of events reported by the log file.

Extract() should be called first.

Definition at line 352 of file File.cxx.

◆ Save()

Int_t erhic::LogReaderGmcTrans::Save ( ) const
virtual

Write the stored cross section and number of events to the active ROOT directory.

Returns the total number of bytes written, or a value <= 0 in the case of an error.

Implements erhic::LogReader.

Definition at line 348 of file File.cxx.

Member Data Documentation

◆ mCrossSection

TObjString erhic::LogReaderGmcTrans::mCrossSection
protected

Total cross section in microbarns.

Definition at line 348 of file File.h.

◆ mNEvents

TObjString erhic::LogReaderGmcTrans::mNEvents
protected

Number of generated events.

Definition at line 347 of file File.h.


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