WriteStdHepFileModule.cxx

Go to the documentation of this file.

// $Id: WriteStdHepFileModule.cxx,v 1.2 2007/08/02 19:02:56 rhatcher Exp $
//
// A Module to write out the StdHep structure found in a SimSnarlRecord
// to a binary file compatible with future use by pre-existing FORTRAN
// programs (e.g. gminos)
//
// rhatcher@fnal.gov
#include "RerootExodus/WriteStdHepFileModule.h"
using namespace std;

#include "TClonesArray.h"
#include "TSystem.h"
#include "TParticle.h"

// MINOS includes
#include "MessageService/MsgService.h"     // MSG text output
#include "MinosObjectMap/MomNavigator.h"   // Data access
#include "Record/SimSnarlHeader.h"
#include "Record/SimSnarlRecord.h"

#include "JobControl/JobCommand.h"         // JobCommand handling
#include "JobControl/JobCModuleRegistry.h" // JOBMODULE registration macro

#include "Util/UtilPDG.h"
#include "Util/UtilHepevt.h"

CVSID("$Id: WriteStdHepFileModule.cxx,v 1.2 2007/08/02 19:02:56 rhatcher Exp $");
JOBMODULE(WriteStdHepFileModule,"WriteStdHepFileModule","Write /HEPEVT/ file.\n");

//......................................................................

WriteStdHepFileModule::WriteStdHepFileModule()
  : fStdHepFilename("blah.dat"), fD(-1), fIonScheme(UtilPDG::kIonUnchanged), 
    fRecordSets(0)
{

}

//......................................................................

const Registry& WriteStdHepFileModule::DefaultConfig() const
{
//======================================================================
// Create a registry which holds the default configuration and return it
//======================================================================
  static Registry r;

  // Set name of config
  std::string name = this->GetName();
  name += ".config.default";
  r.SetName(name.c_str());

  // Set values of config
  r.UnLockValues();
  r.Set("OutputFilename","hepevt.dat");
  r.Set("ConvertIonPDG",(int)UtilPDG::kIonUnchanged);
  r.LockValues();

  return r;
}

//......................................................................

void WriteStdHepFileModule::Config(const Registry& r)
{
//======================================================================
// Configure the module given the registry r
//======================================================================
    const char*   tmpc;
    int           tmpi;

    std::string oldname(fStdHepFilename);
    if (r.Get("OutputFilename",tmpc)) fStdHepFilename = std::string(tmpc);

    if (fStdHepFilename != oldname) CloseFile();

    if (r.Get("ConvertIonPDG",tmpi)) {
      if (fIonScheme != tmpi) {
        MSG("Exodus",Msg::kInfo) 
          << GetName() << " will convert ions using "
          << UtilPDG::ionSchemeName((UtilPDG::ionscheme_t)tmpi)
          << "." << endl;
      }
      fIonScheme = tmpi;
    }
}

//......................................................................

void WriteStdHepFileModule::Report() 
{
  MSG("Exodus",Msg::kInfo) 
    << "Report for WriteStdHepFileModule Module:" << endl;

  MSG("Exodus",Msg::kInfo) 
    << "   Processed " << fRecordSets << " records written to " 
    << fStdHepFilename << "." << endl;
}

//......................................................................

void WriteStdHepFileModule::EndJob() 
{
    Report();
    CloseFile();
}

//......................................................................

void WriteStdHepFileModule::OpenFile() 
{
  MSG("Exodus",Msg::kInfo) 
    << "Open file: " << fStdHepFilename << endl;

  fD = UtilHepevt::openBinary(fStdHepFilename.c_str(),true);

  if (fD < 0) {
    MSG("Exodus",Msg::kInfo) 
      << GetName() << " failed to open file: " 
      << fStdHepFilename << "." << endl;
  }

}

//......................................................................

void WriteStdHepFileModule::CloseFile() 
{
  if ( fD < 0 ) return;  // nothing open

  MSG("Exodus",Msg::kInfo) 
    << "Closing file: " << fStdHepFilename << endl;

  UtilHepevt::closeBinary(fD);
  fD = -1;

}

//......................................................................

JobCResult WriteStdHepFileModule::Ana(const MomNavigator *mom) 
{

  JobCResult result = JobCResult::kFailed;
  int snarlsInRecSet = 0;

  TObject* recObj = 0;

  // find the SimSnarlRecord
  TIter recItr = mom->FragmentIter();
  while ( ( recObj = recItr.Next() ) ) {
    SimSnarlRecord* simrec = dynamic_cast<SimSnarlRecord*>(recObj);
    if (!simrec) continue;  // skip things in mom that aren't SimSnarlRecords

    const SimSnarlHeader* simhead = simrec->GetSimSnarlHeader();
    int evtnum = simhead->GetSnarl();

    const TObject* obj = simrec->FindComponent("TClonesArray","StdHep");
    const TClonesArray* stdhep = dynamic_cast<const TClonesArray*>(obj);

    if (stdhep) {
      if ( fD < 0 ) OpenFile();  // if first time open the file
      // record current scheme for translating ion codes
      UtilPDG::ionscheme_t ionsave = UtilPDG::getDfltStdIonScheme();
      // set requested scheme
      UtilPDG::setDfltStdIonScheme((UtilPDG::ionscheme_t)fIonScheme);
      // fill the /HEPEVT/ common from the TClonesArray of TParticles
      UtilHepevt::fillCommon(stdhep);
      // set the event # in /HEPEVT/ common
      UtilHepevt::setNevHep(evtnum);
      // write the binary file from the /HEPEVT/ common
      if ( UtilHepevt::writeBinary(fD) ) {
        // count record that have been processed
        fRecordSets++;
        snarlsInRecSet++;
        result = JobCResult::kPassed;
      }
      // restore the ion translation scheme
      UtilPDG::setDfltStdIonScheme(ionsave);
    }
    
  }

  if ( snarlsInRecSet > 1 ) {
      MSG("Exodus",Msg::kWarning )
          << GetName() 
          << " RecordSet contained more than one StdHep "
          << endl;
  }
  return result;
}

---