herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.4
Herwig::HerwigUI Class Referenceabstract

HerwigUI is an interface to abstract the command line parameters. More...

#include <HerwigUI.h>

Inheritance diagram for Herwig::HerwigUI:

Public Member Functions

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.
 

Detailed Description

HerwigUI is an interface to abstract the command line parameters.

This allows any inheriting class to configure Herwig wihtout actually having to interact via main()

Definition at line 31 of file HerwigUI.h.


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