Herwig7Utils.ConfigurationCommands Class Reference

Class for handling commands to modify the generator configuration. More...

Collaboration diagram for Herwig7Utils.ConfigurationCommands:

Public Member Functions
	__init__ (self)
	lock (self)
	add (self, commands)

Public Attributes
str	commands = ""
bool	locked = False

Static Private Attributes
	__iadd__ = add

Detailed Description

Class for handling commands to modify the generator configuration.

The specific purpose of this class is to provide a mechanism for the locking of the generator configuration after the creation of the Herwig7 input file. The input file gets written upon execution of onoe of the run or build functions of the specific generator configuration object. Beyond this point no further modification of the configuration in the job options can be propagated and used in the Herwig7 run.

Definition at line 23 of file Herwig7Utils.py.

Constructor & Destructor Documentation

__init__()

Herwig7Utils.ConfigurationCommands.__init__

(

self

)

Definition at line 25 of file Herwig7Utils.py.

  def __init__(self):
    self.commands = ""
    self.locked = False
  

Member Function Documentation

add()

Herwig7Utils.ConfigurationCommands.add	(		self,
			commands )

Definition at line 32 of file Herwig7Utils.py.

  def add(self, commands):
    if self.locked is False:
      self.commands += commands
    else:
      raise RuntimeError("The commands associated to this configuration object can't be modified anymore because the Herwig7 infile has already been written to disk. Therefore, any subsequent additional modifications can't be adopted in the Herwig7 run.")
    return(self)
  

lock()

Herwig7Utils.ConfigurationCommands.lock

(

self

)

Definition at line 29 of file Herwig7Utils.py.

  def lock(self):
    self.locked = True
  

Member Data Documentation

__iadd__

Herwig7Utils.ConfigurationCommands.__iadd__ = add

staticprivate

Definition at line 39 of file Herwig7Utils.py.

commands

str Herwig7Utils.ConfigurationCommands.commands = ""

Definition at line 26 of file Herwig7Utils.py.

locked

bool Herwig7Utils.ConfigurationCommands.locked = False

Definition at line 27 of file Herwig7Utils.py.

---

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

• Herwig7Utils.py