SimulatorBase.h

#ifndef SIMCORE_SIMULATOR_BASE_H_
#define SIMCORE_SIMULATOR_BASE_H_
 
#include <G4CascadeParameters.hh>
#include <G4GeometryManager.hh>
#include <G4UImanager.hh>
#include <G4UIsession.hh>
 
#include "Framework/Configure/Parameters.h"
#include "Framework/EventFile.h"
#include "Framework/EventHeader.h"
#include "Framework/EventProcessor.h"
#include "Framework/Logger.h"
#include "SimCore/ConditionsInterface.h"
#include "SimCore/DetectorConstruction.h"
#include "SimCore/G4Session.h"
#include "SimCore/G4User/TrackingAction.h"
#include "SimCore/G4User/UserEventInformation.h"
#include "SimCore/Geo/Parser.h"
#include "SimCore/RunManager.h"
#include "SimCore/SDs/SensitiveDetector.h"
 
namespace simcore {
class SimulatorBase : public framework::Producer {
 public:
  SimulatorBase(const std::string& name, framework::Process& process);
  virtual ~SimulatorBase() = default;
  void configure(framework::config::Parameters& parameters) override;
 
 protected:
  void onProcessEnd() override;
  void onProcessStart() override;
  ConditionsInterface conditions_intf_;
 
  G4UImanager* ui_manager_{nullptr};
 
  std::unique_ptr<RunManager> run_manager_;
 
  std::unique_ptr<LoggedSession> session_handle_;
 
  static const std::vector<std::string> INVALID_COMMANDS;
 
  /*********************************************************
   * Python Configuration Parameters
   *********************************************************/
  framework::config::Parameters parameters_;
 
  std::vector<std::string> pre_init_commands_;
 
  std::vector<std::string> post_init_commands_;
 
  /*
   *
   * On succesful event, update event header properties like total PN/EN energy
   * and event weight.
   *
   */
  virtual void updateEventHeader(ldmx::EventHeader& eventHeader) const;
 
  /*
   * Save all tracks from the event that are marked for saving
   */
  virtual void saveTracks(framework::Event& event);
 
  /*
   * Save hits from sensitive detectors.
   */
  virtual void saveSDHits(framework::Event& event);
 
  /*
   * Save photonuclear interactions if tracking is enabled.
   */
  virtual void savePhotonuclearInteractions(framework::Event& event);
 
  virtual void produce(framework::Event& event) override = 0;
 
 private:
  /*
   * Set up logging for Geant4 during initialization
   *
   *  If the verbosity level is set to 0, create a batch session
   *  If the verbosity level is > 1, log everything to a file.
   *  Otherwise, dump the output. If a prefix has been specified, append it ot
   *  the log message.
   **/
  void createLogging();
 
  /*
   * Create the GDML parser and load the detector geometry during
   * initialization.
   */
  void buildGeometry();
 
  /*
   * Check that no invalid commands have been requested or that the old style
   * of setting the run number on the simulator rather than the process object
   * wasn't used.
   *
   * @see invalidCommands_
   */
  void verifyParameters() const;
 
 protected:
  /*
   * Enable logging
   */
  enableLogging("SimulatorBase")
};
}  // namespace simcore
 
#endif /* SIMCORE_SIMULATOR_BASE_H_ */