Herwig::HerwigUIProvider Class Reference

#include <HerwigUIProvider.h>

Inheritance diagram for Herwig::HerwigUIProvider:

Public Member Functions
const std::vector< std::string > &	appendReadDirectories () const override
std::ostream &	errStream () const override
	Return the standard err stream to be used. More...
	HerwigUIProvider (const edm::ParameterSet &pset, std::string inputFileName, RunMode::Mode)
	Constructor from the arguments provided by CMSSW. More...
std::string	inputfile () const override
	Name of the file to be read. More...
std::istream &	inStream () const override
	Return the standard in stream to be used. More...
std::string	integrationList () const override
int	jobs () const override
unsigned int	jobSize () const override
unsigned int	maxJobs () const override
long	N () const override
std::ostream &	outStream () const override
	Return the standard out stream to be used. More...
const std::vector< std::string > &	prependReadDirectories () const override
void	quit () const override
void	quitWithHelp () const override
std::string	repository () const override
	Repository name to operate on. More...
bool	resume () const override
	Try to resume execution from an earlier interrupted run. More...
RunMode::Mode	runMode () const override
	Requested Herwig run mode. More...
int	seed () const override
void	setRunMode (RunMode::Mode runMode, const edm::ParameterSet &pset, std::string inputFile="")
void	setSeed (long seed)
std::string	setupfile () const override
	Name of the setup file to be read, to modify the repository. More...
std::string	tag () const override
	A user-defined tag to append to the run name. More...
bool	tics () const override
	Require verbose progress markers. More...
	~HerwigUIProvider () override
	Destructor to leave a clean ThePEG::Repository behind. More...

Private Attributes
std::vector< std::string >	appendReadDirectories_
std::string	inputfile_
std::string	integrationList_
int	jobs_
unsigned int	jobsize_
unsigned int	maxjobs_
long	nEvents_
std::vector< std::string >	prependReadDirectories_
std::string	repository_
bool	resume_
RunMode::Mode	runMode_
int	seed_
std::string	setupfile_
std::string	tag_
bool	tics_

Detailed Description

HerwigUIProvider is an implementation of the HerwigUI interface getting its input from CMSSW configs.

Definition at line 18 of file HerwigUIProvider.h.

Constructor & Destructor Documentation

Herwig::HerwigUIProvider::HerwigUIProvider	(	const edm::ParameterSet &	pset,
		std::string	inputFileName,
		RunMode::Mode	runMode
	)

Constructor from the arguments provided by CMSSW.

Definition at line 34 of file HerwigUIProvider.cc.

References appendReadDirectories_, dqm::qstatus::ERROR, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), mps_fire::i, integrationList_, jobs_, jobsize_, maxjobs_, nEvents_, prependReadDirectories_, repository_, gen::ParameterCollector::resolve(), resume_, runMode_, seed_, setupfile_, AlCaHLTBitMon_QueryRunRegistry::string, tag_, and tics_.

  : runMode_(runMode), 
    resume_(false), tics_(true), tag_(),
    inputfile_(inputFileName), repository_(), setupfile_(),
    integrationList_(),
    nEvents_(-1), seed_(0), jobs_(1),
    jobsize_(0), maxjobs_(0)
{

  // check runMode of program and terminate if error state
  if (runMode_ == RunMode::ERROR)
      edm::LogError("Herwig7Interface") << "Invalid run mode: RunMode::ERROR was passed to Herwig.\n";

/*
  std::string tmpRunMode = pset.getUntrackedParameter<std::string>("runMode", "read");
  if      ( tmpRunMode == "init" )       { runMode_ = RunMode::INIT; }
  else if ( tmpRunMode == "read" )       { runMode_ = RunMode::READ; }
  else if ( tmpRunMode == "build" )      { runMode_ = RunMode::BUILD; }
  else if ( tmpRunMode == "integrate" )  { runMode_ = RunMode::INTEGRATE; }
  else if ( tmpRunMode == "mergegrids" ) { runMode_ = RunMode::MERGEGRIDS; }
  else if ( tmpRunMode == "run" )        { runMode_ = RunMode::RUN; }
  else {
    runMode_ = RunMode::ERROR;
    quitWithHelp();
  }
*/

  // File path to repository file
  repository_  = gen::ParameterCollector::resolve(pset.getParameter<std::string>("repository"));
  if (repository_.empty()) {
    repository_ = std::string("HerwigDefaults.rpo");
  }

  // Number of events
  if ( pset.getUntrackedParameter<int>("numberEvents", -1) != -1 )
    nEvents_ = pset.getUntrackedParameter<int>("numberEvents", 1);


  // run name tag (default given in ggo file)
  if ( !pset.getUntrackedParameter<std::string>("runTag", "").empty())
    tag_ = pset.getUntrackedParameter<std::string>("runTag", "Tag1");

  // Debugging level
  if ( pset.getUntrackedParameter<unsigned int>("debugOutput", 0) )
    ThePEG::Debug::setDebug( pset.getUntrackedParameter<unsigned int>("debugOutput", 0) );

  // Floating point exceptions
  if ( pset.getUntrackedParameter<bool>("debugFPE", false) ) 
    ThePEG::Debug::unmaskFpuErrors();

  // Exit-on-error flag
  if ( pset.getUntrackedParameter<bool>("exitOnError", false) )
    ThePEG::Repository::exitOnError() = 1;

  // Tics
  if ( pset.getUntrackedParameter<bool>("hideTics", false) )
    tics_ = false;


 

  // RNG seed
  if ( pset.getUntrackedParameter<int>("seed", 0) != 0 )
    seed_ = pset.getUntrackedParameter<int>("seed", 0);

  // run modification file
  if ( !pset.getUntrackedParameter<std::string>("setupFile", "").empty() )
    setupfile_ = pset.getUntrackedParameter<std::string>("setupFile", "");

  // parallel jobs
  if ( pset.getUntrackedParameter<int>("jobs", 1) != 1 )
    jobs_ = pset.getUntrackedParameter<int>("jobs", 1);
  

  // Directories from which Herwig reads filesystem
  std::vector<std::string> aReadDirectories = pset.getUntrackedParameter<std::vector<std::string> >("appendReadDirectories", std::vector<std::string>() );
  std::vector<std::string> pReadDirectories = pset.getUntrackedParameter<std::vector<std::string> >("prependReadDirectories", std::vector<std::string>() );
  appendReadDirectories_.insert(appendReadDirectories_.end(), aReadDirectories.begin(), aReadDirectories.end());
  prependReadDirectories_.insert(prependReadDirectories_.end(), pReadDirectories.begin(), pReadDirectories.end());

  // Library search path for dlopen()
  std::vector<std::string> aPath = pset.getUntrackedParameter<std::vector<std::string> >("appendPath", std::vector<std::string>() );
  std::vector<std::string> pPath = pset.getUntrackedParameter<std::vector<std::string> >("prependPath", std::vector<std::string>() );
  for ( size_t i = 0; i < aPath.size(); ++i )
    ThePEG::DynamicLoader::appendPath( aPath[i] );
  for ( size_t i = 0; i < pPath.size(); ++i )
    ThePEG::DynamicLoader::prependPath( pPath[i] );
 

  // integration list
  if ( !pset.getUntrackedParameter<std::string>("integrationList", "").empty() ) {
    integrationList_ = "integrationJob" + pset.getUntrackedParameter<std::string>("integrationList", "1");
  }



  // job size
  if ( pset.getUntrackedParameter<unsigned int>("jobSize", 0) != 0 ) {
    if ( runMode_ == RunMode::BUILD ) {
      jobsize_ = pset.getUntrackedParameter<unsigned int>("jobSize", 1);
      ThePEG::SamplerBase::setIntegratePerJob(jobsize_);
    }
  }

  // max integration jobs
  if ( pset.getUntrackedParameter<unsigned int>("maxJobs", 0) != 0 ) {
    if ( runMode_ == RunMode::BUILD ) {
      maxjobs_ = pset.getUntrackedParameter<unsigned int>("maxJobs", 1);
      ThePEG::SamplerBase::setIntegrationJobs(maxjobs_);
    }
  }


  // Resume
  if ( pset.getUntrackedParameter<bool>("resume", false) )
    resume_ = true;
  

}

Herwig::HerwigUIProvider::~HerwigUIProvider ( )

override

Destructor to leave a clean ThePEG::Repository behind.

Definition at line 30 of file HerwigUIProvider.cc.

References edm::cleanup().

                                    {
  ThePEG::Repository::cleanup();
}

Member Function Documentation

const std::vector<std::string>& Herwig::HerwigUIProvider::appendReadDirectories ( ) const

inlineoverride

Definition at line 57 of file HerwigUIProvider.h.

References appendReadDirectories_.

{ return appendReadDirectories_; }

std::ostream& Herwig::HerwigUIProvider::errStream ( ) const

inlineoverride

Return the standard err stream to be used.

Definition at line 73 of file HerwigUIProvider.h.

References MessageLogger_cfi::cerr.

{ return std::cerr; }

std::string Herwig::HerwigUIProvider::inputfile ( ) const

inlineoverride

Name of the file to be read.

Definition at line 42 of file HerwigUIProvider.h.

References inputfile_.

{ return inputfile_; }

std::istream& Herwig::HerwigUIProvider::inStream ( ) const

inlineoverride

Return the standard in stream to be used.

Definition at line 76 of file HerwigUIProvider.h.

References analyzePatCleaning_cfg::inputFile, runMode(), setRunMode(), and AlCaHLTBitMon_QueryRunRegistry::string.

{ return std::cin; }

std::string Herwig::HerwigUIProvider::integrationList ( ) const

inlineoverride

Definition at line 50 of file HerwigUIProvider.h.

References integrationList_.

{ return integrationList_; }

int Herwig::HerwigUIProvider::jobs ( ) const

inlineoverride

Definition at line 61 of file HerwigUIProvider.h.

References jobs_.

{ return jobs_; }

unsigned int Herwig::HerwigUIProvider::jobSize ( ) const

inlineoverride

Definition at line 62 of file HerwigUIProvider.h.

References jobsize_.

{ return jobsize_; }

unsigned int Herwig::HerwigUIProvider::maxJobs ( ) const

inlineoverride

Definition at line 63 of file HerwigUIProvider.h.

References maxjobs_, quit(), and quitWithHelp().

{ return maxjobs_; }  

long Herwig::HerwigUIProvider::N ( ) const

inlineoverride

Definition at line 59 of file HerwigUIProvider.h.

References nEvents_.

{ return  nEvents_; }

std::ostream& Herwig::HerwigUIProvider::outStream ( ) const

inlineoverride

Return the standard out stream to be used.

Definition at line 70 of file HerwigUIProvider.h.

References gather_cfg::cout.

{ return std::cout; }

const std::vector<std::string>& Herwig::HerwigUIProvider::prependReadDirectories ( ) const

inlineoverride

Definition at line 54 of file HerwigUIProvider.h.

References prependReadDirectories_.

{ return prependReadDirectories_; }

void Herwig::HerwigUIProvider::quit ( ) const

override

Definition at line 25 of file HerwigUIProvider.cc.

References edm::cleanup().

Referenced by maxJobs(), and quitWithHelp().

                                  {
  ThePEG::Repository::cleanup();
  edm::LogInfo("Herwig7Interface") << "Quitting HerwigUIProvider after ThePEG repository cleanup.";
}

void Herwig::HerwigUIProvider::quitWithHelp ( ) const

override

Definition at line 20 of file HerwigUIProvider.cc.

References quit().

Referenced by Herwig7Interface::callHerwigGenerator(), and maxJobs().

                                          {
edm::LogError("Herwig7Interface") << "An error occured, interface quits now.";
  quit();
}

std::string Herwig::HerwigUIProvider::repository ( ) const

inlineoverride

Repository name to operate on.

Definition at line 45 of file HerwigUIProvider.h.

References repository_.

{ return repository_; }

bool Herwig::HerwigUIProvider::resume ( ) const

inlineoverride

Try to resume execution from an earlier interrupted run.

Definition at line 33 of file HerwigUIProvider.h.

References resume_.

{ return resume_; }

RunMode::Mode Herwig::HerwigUIProvider::runMode ( ) const

inlineoverride

Requested Herwig run mode.

Definition at line 28 of file HerwigUIProvider.h.

References runMode_.

Referenced by Herwig7Interface::callHerwigGenerator(), Herwig7Interface::initGenerator(), Herwig7Interface::initRepository(), inStream(), and setRunMode().

{ return runMode_; }

int Herwig::HerwigUIProvider::seed ( ) const

inlineoverride

Definition at line 60 of file HerwigUIProvider.h.

References seed_.

Referenced by setSeed().

{ return seed_; }

void Herwig::HerwigUIProvider::setRunMode	(	RunMode::Mode	runMode,
		const edm::ParameterSet &	pset,
		std::string	inputFile = ""
	)

Change run mode of Herwig Additionally pass the name of the new input file

Function sets jobsize_ and maxjobs_ accordingly to the run modes.

Definition at line 158 of file HerwigUIProvider.cc.

References edm::ParameterSet::getUntrackedParameter(), inputfile_, jobsize_, maxjobs_, runMode(), and runMode_.

Referenced by Herwig7Interface::initRepository(), and inStream().

{
    runMode_ = runMode;
    if( !inputFile.empty())
        inputfile_ = inputFile;

    /* If build mode is chosen set these parameters accordingly, else unset them.*/
    if (runMode_ == RunMode::BUILD)
    {
        // job size
        if ( pset.getUntrackedParameter<unsigned int>("jobSize", 0) != 0 )
        {
            jobsize_ = pset.getUntrackedParameter<unsigned int>("jobSize", 1);
            ThePEG::SamplerBase::setIntegratePerJob(jobsize_);
        }
        // max integration jobs
        if ( pset.getUntrackedParameter<unsigned int>("maxJobs", 0) != 0 )
        {
            maxjobs_ = pset.getUntrackedParameter<unsigned int>("maxJobs", 1);
            ThePEG::SamplerBase::setIntegrationJobs(maxjobs_);
        }
    } else {
        jobsize_ = 0;
        ThePEG::SamplerBase::setIntegratePerJob(jobsize_);
        maxjobs_ = 0;
        ThePEG::SamplerBase::setIntegrationJobs(maxjobs_);
    }
}

void Herwig::HerwigUIProvider::setSeed ( long  seed )

inline

Definition at line 29 of file HerwigUIProvider.h.

References seed(), and seed_.

Referenced by Herwig7Interface::callHerwigGenerator().

{ seed_=seed; }

std::string Herwig::HerwigUIProvider::setupfile ( ) const

inlineoverride

Name of the setup file to be read, to modify the repository.

Definition at line 48 of file HerwigUIProvider.h.

References setupfile_.

{ return setupfile_; }

std::string Herwig::HerwigUIProvider::tag ( ) const

inlineoverride

A user-defined tag to append to the run name.

Definition at line 39 of file HerwigUIProvider.h.

References tag_.

{ return tag_; }

bool Herwig::HerwigUIProvider::tics ( ) const

inlineoverride

Require verbose progress markers.

Definition at line 36 of file HerwigUIProvider.h.

References tics_.

{ return tics_; }

Member Data Documentation

std::vector<std::string> Herwig::HerwigUIProvider::appendReadDirectories_

private

Definition at line 102 of file HerwigUIProvider.h.

Referenced by appendReadDirectories(), and HerwigUIProvider().

std::string Herwig::HerwigUIProvider::inputfile_

private

Definition at line 95 of file HerwigUIProvider.h.

Referenced by inputfile(), and setRunMode().

std::string Herwig::HerwigUIProvider::integrationList_

private

Definition at line 99 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and integrationList().

int Herwig::HerwigUIProvider::jobs_

private

Definition at line 106 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and jobs().

unsigned int Herwig::HerwigUIProvider::jobsize_

private

Definition at line 107 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), jobSize(), and setRunMode().

unsigned int Herwig::HerwigUIProvider::maxjobs_

private

Definition at line 108 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), maxJobs(), and setRunMode().

long Herwig::HerwigUIProvider::nEvents_

private

Definition at line 104 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and N().

std::vector<std::string> Herwig::HerwigUIProvider::prependReadDirectories_

private

Definition at line 101 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and prependReadDirectories().

std::string Herwig::HerwigUIProvider::repository_

private

Definition at line 96 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and repository().

bool Herwig::HerwigUIProvider::resume_

private

Definition at line 91 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and resume().

RunMode::Mode Herwig::HerwigUIProvider::runMode_

private

Definition at line 89 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), runMode(), and setRunMode().

int Herwig::HerwigUIProvider::seed_

private

Definition at line 105 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), seed(), and setSeed().

std::string Herwig::HerwigUIProvider::setupfile_

private

Definition at line 97 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and setupfile().

std::string Herwig::HerwigUIProvider::tag_

private

Definition at line 93 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and tag().

bool Herwig::HerwigUIProvider::tics_

private

Definition at line 92 of file HerwigUIProvider.h.

Referenced by HerwigUIProvider(), and tics().