include/Geant4/G4ApplicationState.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 // G4ApplicationState
0027 //
0028 // Description:
0029 //
0030 // Specifies the state of the G4 application
0031 //
0032 // States:
0033 //  G4State_PreInit
0034 //    At the very beginning of the Application. G4StateManager starts
0035 //    with this state. G4Initializer changes this state to Init when
0036 //    G4Initializer::Initialize() method starts. At the moment of
0037 //    the state change of PreInit->Init, no material, geometrical,
0038 //    particle or physics process has been initialized.
0039 //  G4State_Init
0040 //    During the G4Initializer::Initialize() method. G4Initializer
0041 //    changes this state to Idle when all initialization procedures
0042 //    are successfully Done.
0043 //  G4State_Idle
0044 //    Ready to start "BeamOn". G4RunManager changes this state to
0045 //    GeomClosed when G4RunManager::BeamOn() method starts and
0046 //    G4GeometryManager::CloseGeometry() is Done. At the end of
0047 //    BeamOn() method, G4RunManager will reset the application state
0048 //    to Idle after G4GeometryManager::OpenGeometry() is Done.
0049 //  G4State_GeomClosed
0050 //    Geant4 is in this state between G4GeometryManager::CloseGeometry()
0051 //    and G4GeometryManager::OpenGeometry(), but no event is in
0052 //    progress. At the begining of each event (construction of a
0053 //    G4Event object and primary particle generation), G4RunManager
0054 //    changes this state to EventProc and resets to GeomClosed state
0055 //    when G4EventManager::ProcessOneEvent() is over.
0056 //  G4State_EventProc
0057 //    Processing an event.
0058 //  G4State_Quit
0059 //    Geant4 is in this state when the destructor of G4RunManager is invoked.
0060 //  G4State_Abort
0061 //    Geant4 is in this state when G4Exception is invoked.
0062 //
0063 //
0064 //  PreInit
0065 //    |
0066 //    v
0067 //  Init
0068 //    |
0069 //    v
0070 //  Idle ------> Quit
0071 //    |^
0072 //    v|
0073 //  GeomClosed (at each run)
0074 //    |^
0075 //    v|
0076 //  EventProc (at each event)
0077 //
0078 // --------------------------------------------------------------------
0079 #ifndef G4APPLICATIONSTATE_HH
0080 #define G4APPLICATIONSTATE_HH 1
0081
0082 enum G4ApplicationState
0083 {
0084   G4State_PreInit,
0085   G4State_Init,
0086   G4State_Idle,
0087   G4State_GeomClosed,
0088   G4State_EventProc,
0089   G4State_Quit,
0090   G4State_Abort
0091 };
0092 #endif