Interface to the Herwig7 API. More...

#include <Herwig7.h>

Inheritance diagram for Herwig7API:

Collaboration diagram for Herwig7API:

Public Member Functions
	Herwig7API ()
	Constructor. More...

	~Herwig7API ()
	Destructor. More...

Herwig::RunMode::Mode	runMode () const
	Requested Herwig run mode. More...

virtual bool	resume () const
	Try to resume execution from an earlier interrupted run. More...

virtual bool	tics () const
	Require verbose progress markers. More...

virtual std::string	repository () const
	Repository name to operate on. More...

virtual std::string	inputfile () const
	Name of the file to be read. More...

void	inputfile (const std::string &inputfile)

virtual std::string	setupfile () const
	Name of the setup file to be read, to modify the repository. More...

virtual std::string	tag () const
	A user-defined tag to append to the run name. More...

virtual std::string	integrationList () const
	An identifier for the integration job to be handled. More...

virtual const std::vector< std::string > &	prependReadDirectories () const
	Directories from which Herwig reads input files, will be prepended to the search path. More...

virtual const std::vector< std::string > &	appendReadDirectories () const
	Directories from which Herwig reads input files, will be appended to the search path. More...

virtual long	N () const

virtual int	seed () const
	The number of events to generate. More...

void	seed (int seed)
	The seed to use. More...

virtual int	jobs () const

virtual unsigned int	jobSize () const
	The number of jobs to fork. More...

virtual unsigned int	maxJobs () const
	The number of subprocesses to integrate per integratoin job. More...

virtual void	quitWithHelp () const
	The maximum number of integration jobs. More...

virtual void	quit () const
	Bail out and be quiet. More...

virtual std::ostream &	outStream () const
	Return the standard out stream to be used. More...

virtual std::ostream &	errStream () const
	Return the standard err stream to be used. More...

virtual std::istream &	inStream () const
	Return the standard in stream to be used. More...

Private Attributes
Herwig::RunMode::Mode	m_runMode {}

std::string	m_repository

std::string	m_inputfile

std::string	m_setupfile

std::string	m_tag

std::string	m_integrationList

std::vector< std::string >	m_prependReadDirectories

std::vector< std::string >	m_appendReadDirectories

int	m_seed {}

int	m_jobs {}

unsigned int	m_jobsize {}

unsigned int	m_maxjobs {}

Detailed Description

Interface to the Herwig7 API.

Definition at line 24 of file Herwig7.h.

Constructor & Destructor Documentation

◆ Herwig7API()

Herwig7API::Herwig7API ( )

inline

Constructor.

Definition at line 29 of file Herwig7.h.

29 {};

◆ ~Herwig7API()

Herwig7API::~Herwig7API ( )

inline

Destructor.

Definition at line 35 of file Herwig7.h.

35 {};

Member Function Documentation

◆ appendReadDirectories()

virtual const std::vector<std::string>& Herwig7API::appendReadDirectories ( ) const

inlinevirtual

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

Definition at line 69 of file Herwig7.h.

69 { return(m_appendReadDirectories); }

◆ errStream()

virtual std::ostream& Herwig7API::errStream ( ) const

inlinevirtual

Return the standard err stream to be used.

Definition at line 99 of file Herwig7.h.

99 { return(std::cerr); }

◆ inputfile() [1/2]

virtual std::string Herwig7API::inputfile ( ) const

inlinevirtual

Name of the file to be read.

Definition at line 52 of file Herwig7.h.

52 { return(m_inputfile); }

◆ inputfile() [2/2]

void Herwig7API::inputfile ( const std::string & inputfile )

inline

Definition at line 53 of file Herwig7.h.

53 { m_inputfile = inputfile; }

◆ inStream()

virtual std::istream& Herwig7API::inStream ( ) const

inlinevirtual

Return the standard in stream to be used.

Definition at line 102 of file Herwig7.h.

102 { return(std::cin); }

◆ integrationList()

virtual std::string Herwig7API::integrationList ( ) const

inlinevirtual

An identifier for the integration job to be handled.

Definition at line 62 of file Herwig7.h.

62 { return(m_integrationList); }

◆ jobs()

virtual int Herwig7API::jobs ( ) const

inlinevirtual

Definition at line 77 of file Herwig7.h.

77 { return(m_jobs); }

◆ jobSize()

virtual unsigned int Herwig7API::jobSize ( ) const

inlinevirtual

The number of jobs to fork.

Definition at line 78 of file Herwig7.h.

78 { return(m_jobsize); }

◆ maxJobs()

virtual unsigned int Herwig7API::maxJobs ( ) const

inlinevirtual

The number of subprocesses to integrate per integratoin job.

Definition at line 79 of file Herwig7.h.

79 { return(m_maxjobs); }

◆ N()

virtual long Herwig7API::N ( ) const

inlinevirtual

Definition at line 72 of file Herwig7.h.

72 { return 0; }

◆ outStream()

virtual std::ostream& Herwig7API::outStream ( ) const

inlinevirtual

Return the standard out stream to be used.

Definition at line 96 of file Herwig7.h.

96 { return(std::cout); }

◆ prependReadDirectories()

virtual const std::vector<std::string>& Herwig7API::prependReadDirectories ( ) const

inlinevirtual

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

Definition at line 66 of file Herwig7.h.

66 { return(m_prependReadDirectories); }

◆ quit()

virtual void Herwig7API::quit ( ) const

inlinevirtual

Bail out and be quiet.

Definition at line 90 of file Herwig7.h.

                             {
     ThePEG::Repository::cleanup();
     std::abort();
   }

◆ quitWithHelp()

virtual void Herwig7API::quitWithHelp ( ) const

inlinevirtual

The maximum number of integration jobs.

Bail out and print usage information

Definition at line 82 of file Herwig7.h.

                                     {
     std::cerr << "=================================\n";
     std::cerr << "HERE I CAN PUT SOME ERROR MESSAGE\n";
     std::cerr << "=================================\n";
     quit();
   }

◆ repository()

virtual std::string Herwig7API::repository ( ) const

inlinevirtual

Repository name to operate on.

Definition at line 49 of file Herwig7.h.

49 { return(m_repository); }

◆ resume()

virtual bool Herwig7API::resume ( ) const

inlinevirtual

Try to resume execution from an earlier interrupted run.

Definition at line 42 of file Herwig7.h.

42 { return false; }

◆ runMode()

Herwig::RunMode::Mode Herwig7API::runMode ( ) const

inline

Requested Herwig run mode.

Definition at line 39 of file Herwig7.h.

39 { return(m_runMode); }

◆ seed() [1/2]

virtual int Herwig7API::seed ( ) const

inlinevirtual

The number of events to generate.

Definition at line 74 of file Herwig7.h.

74 { return(m_seed); }

◆ seed() [2/2]

void Herwig7API::seed ( int seed )

inline

The seed to use.

Definition at line 75 of file Herwig7.h.

75 { m_seed = seed; }

◆ setupfile()

virtual std::string Herwig7API::setupfile ( ) const

inlinevirtual

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

Definition at line 56 of file Herwig7.h.

56 { return(m_setupfile); }

◆ tag()

virtual std::string Herwig7API::tag ( ) const

inlinevirtual

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

Definition at line 59 of file Herwig7.h.

59 { return(m_tag); }

◆ tics()

virtual bool Herwig7API::tics ( ) const

inlinevirtual

Require verbose progress markers.

Definition at line 45 of file Herwig7.h.

45 { return false; }

Member Data Documentation

◆ m_appendReadDirectories

std::vector<std::string> Herwig7API::m_appendReadDirectories

private

Definition at line 117 of file Herwig7.h.

◆ m_inputfile

std::string Herwig7API::m_inputfile

private

Definition at line 110 of file Herwig7.h.

◆ m_integrationList

std::string Herwig7API::m_integrationList

private

Definition at line 114 of file Herwig7.h.

◆ m_jobs

int Herwig7API::m_jobs {}

private

Definition at line 120 of file Herwig7.h.

◆ m_jobsize

unsigned int Herwig7API::m_jobsize {}

private

Definition at line 121 of file Herwig7.h.

◆ m_maxjobs

unsigned int Herwig7API::m_maxjobs {}

private

Definition at line 122 of file Herwig7.h.

◆ m_prependReadDirectories

std::vector<std::string> Herwig7API::m_prependReadDirectories

private

Definition at line 116 of file Herwig7.h.

◆ m_repository

std::string Herwig7API::m_repository

private

Definition at line 109 of file Herwig7.h.

◆ m_runMode

Herwig::RunMode::Mode Herwig7API::m_runMode {}

private

Definition at line 107 of file Herwig7.h.

◆ m_seed

int Herwig7API::m_seed {}

private

Definition at line 119 of file Herwig7.h.

◆ m_setupfile

std::string Herwig7API::m_setupfile

private

Definition at line 111 of file Herwig7.h.

◆ m_tag

std::string Herwig7API::m_tag

private

Definition at line 112 of file Herwig7.h.

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

Herwig7.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Herwig7API()

◆ ~Herwig7API()

Member Function Documentation

◆ appendReadDirectories()

◆ errStream()

◆ inputfile() [1/2]

◆ inputfile() [2/2]

◆ inStream()

◆ integrationList()

◆ jobs()

◆ jobSize()

◆ maxJobs()

◆ N()

◆ outStream()

◆ prependReadDirectories()

◆ quit()

◆ quitWithHelp()

◆ repository()

◆ resume()

◆ runMode()

◆ seed() [1/2]

◆ seed() [2/2]

◆ setupfile()

◆ tag()

◆ tics()

Member Data Documentation

◆ m_appendReadDirectories

◆ m_inputfile

◆ m_integrationList

◆ m_jobs

◆ m_jobsize

◆ m_maxjobs

◆ m_prependReadDirectories

◆ m_repository

◆ m_runMode

◆ m_seed

◆ m_setupfile

◆ m_tag