Import Geant4 1.0.0 source tree

source/intercoms/include/G4VStateDependent.hh

@@ -1,12 +1,12 @@
 // This code implementation is the intellectual property of
-// the RD44 GEANT4 collaboration.
+// the GEANT4 collaboration.
 //
 // By copying, distributing or modifying the Program (or any work
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4VStateDependent.hh,v 1.1 1999/01/07 16:09:24 gunter Exp $
-// GEANT4 tag $Name: geant4-00-01 $
+// $Id: G4VStateDependent.hh,v 1.2.4.1 1999/12/07 20:49:01 gunter Exp $
+// GEANT4 tag $Name: geant4-01-00 $
 //
 // 
 // ------------------------------------------------------------
@@ -25,6 +25,15 @@
 #include "globals.hh"
 #include "G4ApplicationState.hh"
 
+// class description:
+//
+//  This is an abstract base class of all classes which need to be
+// notified when the state of Geant4 is changed. The concrete class
+// object derived from this base class will be automatically registered
+// to G4StateManager and the virtual method Notify() will be invoked
+// when the state changes.
+//
+
 class G4VStateDependent {
 
 public:
@@ -33,7 +42,13 @@ public:
   G4int operator==(const G4VStateDependent &right) const;
   G4int operator!=(const G4VStateDependent &right) const;
 
+public: // with description
   virtual G4bool Notify(G4ApplicationState requestedState) = 0;
+  // Pure virtual method which will be invoked by G4StateManager.
+  // In case state change must not be allowed by some reason of the
+  // concrete class, false should be returned. But this scheme is
+  // NOT recommended to use. All command which are state sensitive
+  // MUST assign available state(s).
 
 private:
   G4VStateDependent(const G4VStateDependent &right);