genie::GHepRecordHistory Class Reference

Holds the history of the GHEP event record as it being modified by the processing steps of an event generation thread. The event record history can be used to step back in the generation sequence if a processing step is to be re-run (this the GENIE event generation framework equivalent of an 'Undo') More...

#include <GHepRecordHistory.h>

Inheritance diagram for genie::GHepRecordHistory:

Collaboration diagram for genie::GHepRecordHistory:

Public Member Functions
	GHepRecordHistory ()
	GHepRecordHistory (const GHepRecordHistory &history)
	~GHepRecordHistory ()
void	AddSnapshot (int step, GHepRecord *r)
void	PurgeHistory (void)
void	PurgeRecentHistory (int start_step)
void	ReadFlags (void)
void	Copy (const GHepRecordHistory &history)
void	Print (ostream &stream) const

Private Attributes
bool	fEnabledFull
	keep the full GHEP record history
bool	fEnabledBootstrapStep
	keep only the record that bootsrapped the generation cycle

Friends
ostream &	operator<< (ostream &stream, const GHepRecordHistory &history)

Detailed Description

Holds the history of the GHEP event record as it being modified by the processing steps of an event generation thread. The event record history can be used to step back in the generation sequence if a processing step is to be re-run (this the GENIE event generation framework equivalent of an 'Undo')

Author

Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n September 23, 2005

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org

Definition at line 40 of file GHepRecordHistory.h.

Constructor & Destructor Documentation

GHepRecordHistory() [1/2]

GHepRecordHistory::GHepRecordHistory

(

)

Definition at line 32 of file GHepRecordHistory.cxx.

                                     :
map<int, GHepRecord*>()
{
  this->ReadFlags();
}

References ReadFlags().

Referenced by Copy(), GHepRecordHistory(), and operator<<.

GHepRecordHistory() [2/2]

GHepRecordHistory::GHepRecordHistory

(

const GHepRecordHistory &

history

)

Definition at line 38 of file GHepRecordHistory.cxx.

                                                                      :
map<int, GHepRecord*>()
{
  this->Copy(history);
  this->ReadFlags();
}

References Copy(), GHepRecordHistory(), and ReadFlags().

~GHepRecordHistory()

GHepRecordHistory::~GHepRecordHistory

(

)

Definition at line 45 of file GHepRecordHistory.cxx.

{
  this->PurgeHistory();
}

References PurgeHistory().

Member Function Documentation

AddSnapshot()

void GHepRecordHistory::AddSnapshot	(	int	step,
		GHepRecord *	r )

Definition at line 50 of file GHepRecordHistory.cxx.

{
// Adds a GHepRecord 'snapshot' at the history buffer
 
  bool go_on = (fEnabledFull || (fEnabledBootstrapStep && step==-1));
  if(!go_on) return;
 
  if(!record) {
   LOG("GHEP", pWARN)
    << "Input GHEP record snapshot is null. Is not added at history record";
    return;
  }
 
  if( this->count(step) == 0 ) {
 
     LOG("GHEP", pNOTICE)
                     << "Adding GHEP snapshot for processing step: " << step;
 
     GHepRecord * snapshot = new GHepRecord(*record);
     this->insert( map<int, GHepRecord*>::value_type(step,snapshot));
 
  } else {
     // If you have already stepped back and reprocessing, then you should
     // have purged the 'recent' history (corresponing to 'after the return
     // processing step')
     LOG("GHEP", pWARN)
      << "GHEP snapshot for processing step: " << step << " already exists!";
  }
}

References fEnabledBootstrapStep, fEnabledFull, LOG, pNOTICE, and pWARN.

Referenced by Copy().

Copy()

void GHepRecordHistory::Copy

(

const GHepRecordHistory &

history

)

Definition at line 137 of file GHepRecordHistory.cxx.

{
  this->PurgeHistory();
 
  GHepRecordHistory::const_iterator history_iter;
  for(history_iter = history.begin();
                           history_iter != history.end(); ++history_iter) {
 
    unsigned int step   = history_iter->first;
    GHepRecord * record = history_iter->second;
 
    this->AddSnapshot(step, record);
  }
}

References AddSnapshot(), GHepRecordHistory(), and PurgeHistory().

Referenced by GHepRecordHistory().

Print()

void GHepRecordHistory::Print

(

ostream &

stream

)

const

Definition at line 152 of file GHepRecordHistory.cxx.

{
  stream << "\n ****** Printing GHEP record history"
                              << " [depth: " << this->size() << "]" << endl;
 
  GHepRecordHistory::const_iterator history_iter;
  for(history_iter = this->begin();
                              history_iter != this->end(); ++history_iter) {
 
    unsigned int step   = history_iter->first;
    GHepRecord * record = history_iter->second;
 
    stream << "\n[After processing step = " << step << "] :";
 
    if(!record) {
      stream
         << "** ERR: No history record available for this processing step!";
    } else {
      stream << *record;
    }
  }
}

Referenced by operator<<.

PurgeHistory()

void GHepRecordHistory::PurgeHistory

(

void

)

Definition at line 80 of file GHepRecordHistory.cxx.

{
  LOG("GHEP", pNOTICE) << "Purging GHEP history buffer";
 
  GHepRecordHistory::iterator history_iter;
  for(history_iter = this->begin();
                              history_iter != this->end(); ++history_iter) {
 
    int step = history_iter->first;
    LOG("GHEP", pINFO)
                  << "Deleting GHEP snapshot for processing step: " << step;
 
    GHepRecord * record = history_iter->second;
    if(record) {
      delete record;
      record = 0;
    }
  }
  this->clear();
}

References clear, LOG, pINFO, and pNOTICE.

Referenced by Copy(), PurgeRecentHistory(), and ~GHepRecordHistory().

PurgeRecentHistory()

void GHepRecordHistory::PurgeRecentHistory

(

int

start_step

)

Definition at line 101 of file GHepRecordHistory.cxx.

{
// Snapshots are added to the history record *after* each processing step
// (marked 0,1,2,...). A special snapshot corresponding to the event record
// before any processing step is added with key = -1.
// Therefore GHepRecordHistory keys should be: -1,0,1,2,3,...
 
  LOG("GHEP", pNOTICE)
       << "Purging recent GHEP history buffer (processing step >= "
                                                      << start_step << ")";
 
  if(start_step < -1) {
    LOG("GHEP", pWARN)
               << "Invalid starting step: " << start_step << " - Ignoring";
    return;
  }
 
  if(start_step == -1) {
    // delete everything
    this->PurgeHistory();
    return;
  }
 
  GHepRecordHistory::iterator history_iter;
  for(history_iter = this->begin();
                              history_iter != this->end(); ++history_iter) {
 
    if(history_iter->first >= start_step) {
       int step = history_iter->first;
       LOG("GHEP", pINFO)
                  << "Deleting GHEP snapshot for processing step: " << step;
       this->erase(history_iter);
    }
  }
}

References LOG, pINFO, pNOTICE, PurgeHistory(), and pWARN.

ReadFlags()

void GHepRecordHistory::ReadFlags

(

void

)

Definition at line 175 of file GHepRecordHistory.cxx.

{
  if (gSystem->Getenv("GHEPHISTENABLE")) {
 
     string envvar = string(gSystem->Getenv("GHEPHISTENABLE"));
 
     fEnabledFull          = (envvar=="FULL")      ? true:false;
     fEnabledBootstrapStep = (envvar=="BOOTSTRAP") ? true:false;
 
  } else {
     // set defaults
     fEnabledFull          = false;
     fEnabledBootstrapStep = true;
  }
 
  LOG("GHEP", pINFO) << "GHEP History Flags: ";
  LOG("GHEP", pINFO) << "  - Keep Full History:          "
                     << utils::print::BoolAsYNString(fEnabledFull);
  LOG("GHEP", pINFO) << "  - Keep Bootstrap Record Only: "
                     << utils::print::BoolAsYNString(fEnabledBootstrapStep);
}

References genie::utils::print::BoolAsYNString(), fEnabledBootstrapStep, fEnabledFull, LOG, and pINFO.

Referenced by GHepRecordHistory(), and GHepRecordHistory().

Friends And Related Symbol Documentation

operator<<

ostream & operator<< ( ostream & stream, const GHepRecordHistory & history )

friend

Definition at line 25 of file GHepRecordHistory.cxx.

 {
   history.Print(stream);
   return stream;
 }

References GHepRecordHistory(), and Print().

Member Data Documentation

fEnabledBootstrapStep

bool genie::GHepRecordHistory::fEnabledBootstrapStep

private

keep only the record that bootsrapped the generation cycle

Definition at line 61 of file GHepRecordHistory.h.

Referenced by AddSnapshot(), and ReadFlags().

fEnabledFull

bool genie::GHepRecordHistory::fEnabledFull

private

keep the full GHEP record history

Definition at line 60 of file GHepRecordHistory.h.

Referenced by AddSnapshot(), and ReadFlags().

---

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

• GHepRecordHistory.h
• GHepRecordHistory.cxx