herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.5
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 ~HerwigUI ()
 Destructor.
 
bool integrationJob () const
 Return true, if this is an integration job.
 

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.


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