include/Geant4/G4UIbatch.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4UIbatch
0027 //
0028 // Class description:
0029 //
0030 // This is a concrete class of G4UIsession.
0031 // This class object is instantiated by G4UImanager every time
0032 // the "/control/execute macro_file" command is executed.
0033 // Also, in the case of pure batch mode with a macro file,
0034 // this class can be used as other ordinary G4UIsession
0035 // concrete classes, i.e. SessionStart() is invoked in main().
0036
0037 // Author: M.Asai, 2000
0038 // --------------------------------------------------------------------
0039 #ifndef G4UI_BATCH_HH
0040 #define G4UI_BATCH_HH 1
0041
0042 #include "G4UIsession.hh"
0043
0044 #include <fstream>
0045
0046 class G4UIbatch : public G4UIsession
0047 {
0048   public:
0049     // "prevSession" must be null if this class is constructed from main().
0050     G4UIbatch(const char* fileName, G4UIsession* prevSession = nullptr);
0051
0052     ~G4UIbatch() override;
0053
0054     inline G4UIsession* GetPreviousSession() const;
0055
0056     G4UIsession* SessionStart() override;
0057     void PauseSessionStart(const G4String& Prompt) override;
0058
0059   private:
0060     // Get command from a batch script file
0061     G4String ReadCommand();
0062
0063     G4int ExecCommand(const G4String& command);
0064
0065   private:
0066     G4UIsession* previousSession = nullptr;
0067
0068     std::ifstream macroStream;
0069     G4bool isOpened = false;
0070 };
0071
0072 // --------------------------------------------------------------------
0073 // Inline methods
0074 // --------------------------------------------------------------------
0075
0076 inline G4UIsession* G4UIbatch::GetPreviousSession() const
0077 {
0078   return previousSession;
0079 }
0080
0081 #endif