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 More...
bool	fEnabledBootstrapStep
	keep only the record that bootsrapped the generation cycle More...

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 cern.ch> University of Liverpool

Created:

September 23, 2005

License:

Copyright (c) 2003-2024, 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::GHepRecordHistory

(

)

Definition at line 32 of file GHepRecordHistory.cxx.

References ReadFlags().

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

GHepRecordHistory::GHepRecordHistory

(

const GHepRecordHistory &

history

)

Definition at line 38 of file GHepRecordHistory.cxx.

References Copy(), and ReadFlags().

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

GHepRecordHistory::~GHepRecordHistory

(

)

Definition at line 45 of file GHepRecordHistory.cxx.

References PurgeHistory().

{
  this->PurgeHistory();
}

Member Function Documentation

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

Definition at line 50 of file GHepRecordHistory.cxx.

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

Referenced by Copy(), and genie::EventGenerator::ProcessEventRecord().

{
// 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!";
  }
}

void GHepRecordHistory::Copy

(

const GHepRecordHistory &

history

)

Definition at line 137 of file GHepRecordHistory.cxx.

References AddSnapshot(), and PurgeHistory().

Referenced by GHepRecordHistory().

{
  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);
  }
}

void GHepRecordHistory::Print

(

ostream &

stream

)

const

Definition at line 152 of file GHepRecordHistory.cxx.

Referenced by genie::operator<<().

{
  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;
    }
  }
}

void GHepRecordHistory::PurgeHistory

(

void

)

Definition at line 80 of file GHepRecordHistory.cxx.

References clear, LOG, pINFO, and pNOTICE.

Referenced by Copy(), genie::EventGenerator::ProcessEventRecord(), PurgeRecentHistory(), and ~GHepRecordHistory().

{
  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();
}

void GHepRecordHistory::PurgeRecentHistory

(

int

start_step

)

Definition at line 101 of file GHepRecordHistory.cxx.

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

Referenced by genie::EventGenerator::ProcessEventRecord().

{
// 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);
    }
  }
}

void GHepRecordHistory::ReadFlags

(

void

)

Definition at line 175 of file GHepRecordHistory.cxx.

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

Referenced by GHepRecordHistory().

{
  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);
}

Friends And Related Function Documentation

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

friend

Definition at line 25 of file GHepRecordHistory.cxx.

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

Member Data Documentation

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().

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