include/Geant4/G4UIsession.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 // G4UIsession
0027 //
0028 // Class description:
0029 //
0030 // This is a base class of all (G)UI sessions.
0031 // SessionStart() method should be called to start the session
0032
0033 // Author: Makoto Asai, 1998
0034 // --------------------------------------------------------------------
0035 #ifndef G4UIsession_hh
0036 #define G4UIsession_hh 1
0037
0038 #include "G4coutDestination.hh"
0039 #include "globals.hh"
0040
0041 #include "icomsdefs.hh"
0042
0043 class G4UIsession : public G4coutDestination
0044 {
0045   public:
0046     G4UIsession();
0047     G4UIsession(G4int iBatch);
0048     ~G4UIsession() override;
0049
0050     // This method will be invoked by main().
0051     // Optionally, it can be invoked by another session
0052     virtual G4UIsession* SessionStart();
0053
0054     // This method will be invoked by G4UImanager
0055     // when the kernel comes to Pause state
0056     virtual void PauseSessionStart(const G4String& Prompt);
0057
0058     // These methods will be invoked by G4strstreambuf
0059     G4int ReceiveG4debug(const G4String& debugString) override;
0060     G4int ReceiveG4cout(const G4String& coutString) override;
0061     G4int ReceiveG4cerr(const G4String& cerrString) override;
0062
0063     static G4int InSession();
0064     inline G4int GetLastReturnCode() const { return lastRC; }
0065
0066   protected:
0067     G4ICOMS_DLL static G4int inSession;
0068     G4int ifBatch = 0;
0069     G4int lastRC = 0;
0070 };
0071
0072 #endif