include/Geant4/G4VStateDependent.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 // G4VStateDependent
0027 //
0028 // Class description:
0029 //
0030 // Abstract base class of all classes which need to be notified when
0031 // the state of Geant4 changes. The concrete class object derived from
0032 // this base class will be automatically registered to G4StateManager
0033 // and the virtual method Notify() will be invoked when the state changes.
0034
0035 // Authors: G.Cosmo, M.Asai - November 1996
0036 // --------------------------------------------------------------------
0037 #ifndef G4VStateDependent_hh
0038 #define G4VStateDependent_hh 1
0039
0040 #include "G4ApplicationState.hh"
0041 #include "G4Types.hh"
0042
0043 class G4VStateDependent
0044 {
0045  public:
0046   explicit G4VStateDependent(G4bool bottom = false);
0047   virtual ~G4VStateDependent();
0048   G4bool operator==(const G4VStateDependent& right) const;
0049   G4bool operator!=(const G4VStateDependent& right) const;
0050
0051   virtual G4bool Notify(G4ApplicationState requestedState) = 0;
0052   // Pure virtual method which will be invoked by G4StateManager.
0053   // In case a state change must not be allowed by some reason of the
0054   // concrete class, false should be returned. But this scheme use is
0055   // NOT recommended. All commands which are state sensitive MUST assign
0056   // available state(s).
0057
0058  private:
0059   G4VStateDependent(const G4VStateDependent& right);
0060   G4VStateDependent& operator=(const G4VStateDependent& right);
0061 };
0062
0063 #endif