herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::HerwigCLI Class Reference

HerwigCLI is the default implementation of the HerwigUI interface. More...

#include <HerwigCLI.h>

Inheritance diagram for Herwig::HerwigCLI:

Public Member Functions

 HerwigCLI (int argc, char *argv[])
 Constructor from the arguments provided by main()
 
 ~HerwigCLI ()
 Destructor to leave a clean ThePEG::Repository behind.
 
RunMode::Mode runMode () const
 Requested Herwig run mode.
 
bool resume () const
 Try to resume execution from an earlier interrupted run.
 
bool tics () const
 Require verbose progress markers.
 
std::string tag () const
 A user-defined tag to append to the run name.
 
std::string inputfile () const
 Name of the file to be read.
 
std::string repository () const
 Repository name to operate on.
 
std::string setupfile () const
 Name of the setup file to be read, to modify the repository.
 
std::string integrationList () const
 An identifier for the integration job to be handled.
 
const std::vector< std::string > & prependReadDirectories () const
 Directories from which Herwig reads input files, will be prepended to the search path.
 
const std::vector< std::string > & appendReadDirectories () const
 Directories from which Herwig reads input files, will be appended to the search path.
 
long N () const
 The number of events to generate.
 
int seed () const
 The seed to use.
 
int jobs () const
 The number of jobs to fork.
 
unsigned int jobSize () const
 The number of subprocesses to integrate per integratoin job.
 
unsigned int maxJobs () const
 The maximum number of integration jobs.
 
void quitWithHelp () const
 Bail out and print usage information.
 
void quit () const
 Bail out and be quiet.
 
virtual std::ostream & outStream () const
 Return the standard out stream to be used.
 
virtual std::ostream & errStream () const
 Return the standard err stream to be used.
 
virtual std::istream & inStream () const
 Return the standard in stream to be used.
 
- Public Member Functions inherited from Herwig::HerwigUI
virtual RunMode::Mode runMode () const =0
 Requested Herwig run mode.
 
virtual std::string repository () const =0
 Repository name to operate on.
 
virtual std::string inputfile () const =0
 Name of the file to be read.
 
virtual std::string setupfile () const =0
 Name of the setup file to be read, to modify the repository.
 
virtual bool resume () const =0
 Try to resume execution from an earlier interrupted run.
 
virtual bool tics () const =0
 Require verbose progress markers.
 
virtual std::string tag () const =0
 A user-defined tag to append to the run name.
 
virtual std::string integrationList () const =0
 An identifier for the integration job to be handled.
 
virtual const std::vector< std::string > & prependReadDirectories () const =0
 Directories from which Herwig reads input files, will be prepended to the search path.
 
virtual const std::vector< std::string > & appendReadDirectories () const =0
 Directories from which Herwig reads input files, will be appended to the search path.
 
virtual long N () const =0
 The number of events to generate.
 
virtual int seed () const =0
 The seed to use.
 
virtual int jobs () const =0
 The number of jobs to fork.
 
virtual unsigned int jobSize () const =0
 The number of subprocesses to integrate per integratoin job.
 
virtual unsigned int maxJobs () const =0
 The maximum number of integration jobs.
 
virtual void quitWithHelp () const =0
 Bail out and print usage information.
 
virtual void quit () const =0
 Bail out and be quiet.
 
virtual ~HerwigUI ()
 Destructor.
 
bool integrationJob () const
 Return true, if this is an integration job.
 
virtual std::ostream & outStream () const =0
 Return the standard out stream to be used.
 
virtual std::ostream & errStream () const =0
 Return the standard err stream to be used.
 
virtual std::istream & inStream () const =0
 Return the standard in stream to be used.
 

Private Attributes

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

Detailed Description

HerwigCLI is the default implementation of the HerwigUI interface.

Using the gengetopt tool, we fill all required pieces from reading command line flags from the main executable.

Definition at line 23 of file HerwigCLI.h.

Member Function Documentation

◆ appendReadDirectories()

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

Directories from which Herwig reads input files, will be appended to the search path.

Implements Herwig::HerwigUI.

Definition at line 60 of file HerwigCLI.h.

◆ errStream()

virtual std::ostream & Herwig::HerwigCLI::errStream ( ) const
inlinevirtual

Return the standard err stream to be used.

Implements Herwig::HerwigUI.

Definition at line 76 of file HerwigCLI.h.

◆ inputfile()

std::string Herwig::HerwigCLI::inputfile ( ) const
inlinevirtual

Name of the file to be read.

Implements Herwig::HerwigUI.

Definition at line 45 of file HerwigCLI.h.

◆ inStream()

virtual std::istream & Herwig::HerwigCLI::inStream ( ) const
inlinevirtual

Return the standard in stream to be used.

Implements Herwig::HerwigUI.

Definition at line 79 of file HerwigCLI.h.

◆ integrationList()

std::string Herwig::HerwigCLI::integrationList ( ) const
inlinevirtual

An identifier for the integration job to be handled.

Implements Herwig::HerwigUI.

Definition at line 53 of file HerwigCLI.h.

◆ jobs()

int Herwig::HerwigCLI::jobs ( ) const
inlinevirtual

The number of jobs to fork.

Implements Herwig::HerwigUI.

Definition at line 64 of file HerwigCLI.h.

◆ jobSize()

unsigned int Herwig::HerwigCLI::jobSize ( ) const
inlinevirtual

The number of subprocesses to integrate per integratoin job.

Implements Herwig::HerwigUI.

Definition at line 65 of file HerwigCLI.h.

◆ maxJobs()

unsigned int Herwig::HerwigCLI::maxJobs ( ) const
inlinevirtual

The maximum number of integration jobs.

Implements Herwig::HerwigUI.

Definition at line 66 of file HerwigCLI.h.

◆ N()

long Herwig::HerwigCLI::N ( ) const
inlinevirtual

The number of events to generate.

Implements Herwig::HerwigUI.

Definition at line 62 of file HerwigCLI.h.

◆ outStream()

virtual std::ostream & Herwig::HerwigCLI::outStream ( ) const
inlinevirtual

Return the standard out stream to be used.

Implements Herwig::HerwigUI.

Definition at line 73 of file HerwigCLI.h.

◆ prependReadDirectories()

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

Directories from which Herwig reads input files, will be prepended to the search path.

Implements Herwig::HerwigUI.

Definition at line 57 of file HerwigCLI.h.

◆ quit()

void Herwig::HerwigCLI::quit ( ) const
virtual

Bail out and be quiet.

Implements Herwig::HerwigUI.

◆ quitWithHelp()

void Herwig::HerwigCLI::quitWithHelp ( ) const
virtual

Bail out and print usage information.

Implements Herwig::HerwigUI.

◆ repository()

std::string Herwig::HerwigCLI::repository ( ) const
inlinevirtual

Repository name to operate on.

Implements Herwig::HerwigUI.

Definition at line 48 of file HerwigCLI.h.

◆ resume()

bool Herwig::HerwigCLI::resume ( ) const
inlinevirtual

Try to resume execution from an earlier interrupted run.

Implements Herwig::HerwigUI.

Definition at line 36 of file HerwigCLI.h.

◆ runMode()

RunMode::Mode Herwig::HerwigCLI::runMode ( ) const
inlinevirtual

Requested Herwig run mode.

Implements Herwig::HerwigUI.

Definition at line 33 of file HerwigCLI.h.

◆ seed()

int Herwig::HerwigCLI::seed ( ) const
inlinevirtual

The seed to use.

Implements Herwig::HerwigUI.

Definition at line 63 of file HerwigCLI.h.

◆ setupfile()

std::string Herwig::HerwigCLI::setupfile ( ) const
inlinevirtual

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

Implements Herwig::HerwigUI.

Definition at line 51 of file HerwigCLI.h.

◆ tag()

std::string Herwig::HerwigCLI::tag ( ) const
inlinevirtual

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

Implements Herwig::HerwigUI.

Definition at line 42 of file HerwigCLI.h.

◆ tics()

bool Herwig::HerwigCLI::tics ( ) const
inlinevirtual

Require verbose progress markers.

Implements Herwig::HerwigUI.

Definition at line 39 of file HerwigCLI.h.

Member Data Documentation

◆ appendReadDirectories_

std::vector<std::string> Herwig::HerwigCLI::appendReadDirectories_
private

Definition at line 96 of file HerwigCLI.h.

◆ inputfile_

std::string Herwig::HerwigCLI::inputfile_
private

Definition at line 89 of file HerwigCLI.h.

◆ integrationList_

std::string Herwig::HerwigCLI::integrationList_
private

Definition at line 93 of file HerwigCLI.h.

◆ jobs_

int Herwig::HerwigCLI::jobs_
private

Definition at line 100 of file HerwigCLI.h.

◆ jobsize_

unsigned int Herwig::HerwigCLI::jobsize_
private

Definition at line 101 of file HerwigCLI.h.

◆ maxjobs_

unsigned int Herwig::HerwigCLI::maxjobs_
private

Definition at line 102 of file HerwigCLI.h.

◆ N_

long Herwig::HerwigCLI::N_
private

Definition at line 98 of file HerwigCLI.h.

◆ prependReadDirectories_

std::vector<std::string> Herwig::HerwigCLI::prependReadDirectories_
private

Definition at line 95 of file HerwigCLI.h.

◆ repository_

std::string Herwig::HerwigCLI::repository_
private

Definition at line 90 of file HerwigCLI.h.

◆ resume_

bool Herwig::HerwigCLI::resume_
private

Definition at line 85 of file HerwigCLI.h.

◆ runMode_

RunMode::Mode Herwig::HerwigCLI::runMode_
private

Definition at line 83 of file HerwigCLI.h.

◆ seed_

int Herwig::HerwigCLI::seed_
private

Definition at line 99 of file HerwigCLI.h.

◆ setupfile_

std::string Herwig::HerwigCLI::setupfile_
private

Definition at line 91 of file HerwigCLI.h.

◆ tag_

std::string Herwig::HerwigCLI::tag_
private

Definition at line 87 of file HerwigCLI.h.

◆ tics_

bool Herwig::HerwigCLI::tics_
private

Definition at line 86 of file HerwigCLI.h.


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