herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
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.

Constructor & Destructor Documentation

◆ ~HerwigUI()

virtual Herwig::HerwigUI::~HerwigUI ( )
inlinevirtual

Destructor.

Definition at line 87 of file HerwigUI.h.

Member Function Documentation

◆ appendReadDirectories()

virtual const std::vector< std::string > & Herwig::HerwigUI::appendReadDirectories ( ) const
pure virtual

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

Implemented in Herwig::HerwigCLI.

◆ errStream()

virtual std::ostream & Herwig::HerwigUI::errStream ( ) const
pure virtual

Return the standard err stream to be used.

Implemented in Herwig::HerwigCLI.

◆ inputfile()

virtual std::string Herwig::HerwigUI::inputfile ( ) const
pure virtual

Name of the file to be read.

Implemented in Herwig::HerwigCLI.

◆ inStream()

virtual std::istream & Herwig::HerwigUI::inStream ( ) const
pure virtual

Return the standard in stream to be used.

Implemented in Herwig::HerwigCLI.

◆ integrationJob()

bool Herwig::HerwigUI::integrationJob ( ) const
inline

Return true, if this is an integration job.

Definition at line 90 of file HerwigUI.h.

References runMode().

◆ integrationList()

virtual std::string Herwig::HerwigUI::integrationList ( ) const
pure virtual

An identifier for the integration job to be handled.

Implemented in Herwig::HerwigCLI.

◆ jobs()

virtual int Herwig::HerwigUI::jobs ( ) const
pure virtual

The number of jobs to fork.

Implemented in Herwig::HerwigCLI.

◆ jobSize()

virtual unsigned int Herwig::HerwigUI::jobSize ( ) const
pure virtual

The number of subprocesses to integrate per integratoin job.

Implemented in Herwig::HerwigCLI.

◆ maxJobs()

virtual unsigned int Herwig::HerwigUI::maxJobs ( ) const
pure virtual

The maximum number of integration jobs.

Implemented in Herwig::HerwigCLI.

◆ N()

virtual long Herwig::HerwigUI::N ( ) const
pure virtual

The number of events to generate.

Implemented in Herwig::HerwigCLI.

◆ outStream()

virtual std::ostream & Herwig::HerwigUI::outStream ( ) const
pure virtual

Return the standard out stream to be used.

Implemented in Herwig::HerwigCLI.

◆ prependReadDirectories()

virtual const std::vector< std::string > & Herwig::HerwigUI::prependReadDirectories ( ) const
pure virtual

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

Implemented in Herwig::HerwigCLI.

◆ quit()

virtual void Herwig::HerwigUI::quit ( ) const
pure virtual

Bail out and be quiet.

Implemented in Herwig::HerwigCLI.

◆ quitWithHelp()

virtual void Herwig::HerwigUI::quitWithHelp ( ) const
pure virtual

Bail out and print usage information.

Implemented in Herwig::HerwigCLI.

◆ repository()

virtual std::string Herwig::HerwigUI::repository ( ) const
pure virtual

Repository name to operate on.

Implemented in Herwig::HerwigCLI.

◆ resume()

virtual bool Herwig::HerwigUI::resume ( ) const
pure virtual

Try to resume execution from an earlier interrupted run.

Implemented in Herwig::HerwigCLI.

◆ runMode()

virtual RunMode::Mode Herwig::HerwigUI::runMode ( ) const
pure virtual

Requested Herwig run mode.

Implemented in Herwig::HerwigCLI.

Referenced by integrationJob().

◆ seed()

virtual int Herwig::HerwigUI::seed ( ) const
pure virtual

The seed to use.

Implemented in Herwig::HerwigCLI.

◆ setupfile()

virtual std::string Herwig::HerwigUI::setupfile ( ) const
pure virtual

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

Implemented in Herwig::HerwigCLI.

◆ tag()

virtual std::string Herwig::HerwigUI::tag ( ) const
pure virtual

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

Implemented in Herwig::HerwigCLI.

◆ tics()

virtual bool Herwig::HerwigUI::tics ( ) const
pure virtual

Require verbose progress markers.

Implemented in Herwig::HerwigCLI.


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