herwig
is hosted by
Hepforge
,
IPPP Durham
Herwig
7.3.0
API
HerwigUI.h
1
// -*- C++ -*-
2
//
3
// HerwigUI.h is a part of Herwig - A multi-purpose Monte Carlo event generator
4
// Copyright (C) 2002-2019 The Herwig Collaboration
5
//
6
// Herwig is licenced under version 3 of the GPL, see COPYING for details.
7
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
8
//
9
#ifndef SRC_HERWIG_UI_H
10
#define SRC_HERWIG_UI_H
11
12
#include <vector>
13
#include <string>
14
#include <iosfwd>
15
16
namespace
Herwig
{
17
21
namespace
RunMode {
22
enum
Mode { ERROR, INIT, READ, BUILD, INTEGRATE, MERGEGRIDS, RUN };
23
}
24
31
class
HerwigUI
{
32
33
public
:
34
36
virtual
RunMode::Mode
runMode
()
const
= 0;
37
39
virtual
std::string
repository
()
const
= 0;
40
42
virtual
std::string
inputfile
()
const
= 0;
43
45
virtual
std::string
setupfile
()
const
= 0;
46
48
virtual
bool
resume
()
const
= 0;
49
51
virtual
bool
tics
()
const
= 0;
52
54
virtual
std::string
tag
()
const
= 0;
55
57
virtual
std::string
integrationList
()
const
= 0;
58
60
virtual
const
std::vector<std::string> &
prependReadDirectories
()
const
= 0;
61
63
virtual
const
std::vector<std::string> &
appendReadDirectories
()
const
= 0;
64
66
virtual
long
N
()
const
= 0;
67
69
virtual
int
seed
()
const
= 0;
70
72
virtual
int
jobs
()
const
= 0;
73
75
virtual
unsigned
int
jobSize
()
const
= 0;
76
78
virtual
unsigned
int
maxJobs
()
const
= 0;
79
81
virtual
void
quitWithHelp
()
const
= 0;
82
84
virtual
void
quit
()
const
= 0;
85
87
virtual
~HerwigUI
() {}
88
90
bool
integrationJob
()
const
{
91
return
runMode
() == RunMode::INTEGRATE;
92
}
93
95
virtual
std::ostream&
outStream
()
const
= 0;
96
98
virtual
std::ostream&
errStream
()
const
= 0;
99
101
virtual
std::istream&
inStream
()
const
= 0;
102
103
};
104
105
}
106
107
#endif
Herwig::HerwigUI
HerwigUI is an interface to abstract the command line parameters.
Definition:
HerwigUI.h:31
Herwig::HerwigUI::tics
virtual bool tics() const =0
Require verbose progress markers.
Herwig::HerwigUI::integrationList
virtual std::string integrationList() const =0
An identifier for the integration job to be handled.
Herwig::HerwigUI::seed
virtual int seed() const =0
The seed to use.
Herwig::HerwigUI::setupfile
virtual std::string setupfile() const =0
Name of the setup file to be read, to modify the repository.
Herwig::HerwigUI::integrationJob
bool integrationJob() const
Return true, if this is an integration job.
Definition:
HerwigUI.h:90
Herwig::HerwigUI::inStream
virtual std::istream & inStream() const =0
Return the standard in stream to be used.
Herwig::HerwigUI::quit
virtual void quit() const =0
Bail out and be quiet.
Herwig::HerwigUI::prependReadDirectories
virtual const std::vector< std::string > & prependReadDirectories() const =0
Directories from which Herwig reads input files, will be prepended to the search path.
Herwig::HerwigUI::errStream
virtual std::ostream & errStream() const =0
Return the standard err stream to be used.
Herwig::HerwigUI::tag
virtual std::string tag() const =0
A user-defined tag to append to the run name.
Herwig::HerwigUI::N
virtual long N() const =0
The number of events to generate.
Herwig::HerwigUI::jobSize
virtual unsigned int jobSize() const =0
The number of subprocesses to integrate per integratoin job.
Herwig::HerwigUI::~HerwigUI
virtual ~HerwigUI()
Destructor.
Definition:
HerwigUI.h:87
Herwig::HerwigUI::repository
virtual std::string repository() const =0
Repository name to operate on.
Herwig::HerwigUI::resume
virtual bool resume() const =0
Try to resume execution from an earlier interrupted run.
Herwig::HerwigUI::appendReadDirectories
virtual const std::vector< std::string > & appendReadDirectories() const =0
Directories from which Herwig reads input files, will be appended to the search path.
Herwig::HerwigUI::outStream
virtual std::ostream & outStream() const =0
Return the standard out stream to be used.
Herwig::HerwigUI::quitWithHelp
virtual void quitWithHelp() const =0
Bail out and print usage information.
Herwig::HerwigUI::jobs
virtual int jobs() const =0
The number of jobs to fork.
Herwig::HerwigUI::inputfile
virtual std::string inputfile() const =0
Name of the file to be read.
Herwig::HerwigUI::maxJobs
virtual unsigned int maxJobs() const =0
The maximum number of integration jobs.
Herwig::HerwigUI::runMode
virtual RunMode::Mode runMode() const =0
Requested Herwig run mode.
Herwig
-*- C++ -*-
Definition:
BasicConsistency.h:17
Generated on Thu Jun 20 2024 17:50:52 for Herwig by
1.9.6