eventDispenser
Loading...
Searching...
No Matches
eventDispenser Namespace Reference

Namespace containing the Event Dispenser module option definitions.

Functions

GOptions defineOptions ()
 Builds and returns the complete set of options supported by the Event Dispenser module.

Variables

constexpr int ERR_EVENTDISTRIBUTIONFILENOTFOUND = 701
 Run-weight file could not be opened/read.

Function Documentation

◆ defineOptions()

GOptions eventDispenser::defineOptions ( )

The returned GOptions object:

  • Defines Event Dispenser specific options (e.g. number of events, run number, run-weight file).
  • Appends options required by dependent modules (e.g. dynamic digitization).

This function is intended to be used during application startup to initialize GOptions, typically by passing the returned object into the GOptions constructor that parses argc/argv.

Returns
A GOptions instance containing all option definitions for this module.

Definition at line 18 of file eventDispenser_options.cc.

Variable Documentation

◆ ERR_EVENTDISTRIBUTIONFILENOTFOUND

int eventDispenser::ERR_EVENTDISTRIBUTIONFILENOTFOUND = 701
inlineconstexpr

Emitted when the user provided a run-weight filename but the file cannot be opened.

Definition at line 17 of file eventDispenserConventions.h.