Module.hh

Go to the documentation of this file.

// $Header: /cvs/lcd/slic/include/Module.hh,v 1.8 2007/04/27 01:54:32 jeremy Exp $

#ifndef SLIC_MODULE_HH
#define SLIC_MODULE_HH 1

// slic
#include "LogStream.hh"

// std
#include <string>

// geant4
#include "G4ClassificationOfNewTrack.hh"

class G4Event;
class G4Run;
class G4Step;
class G4Track;

namespace slic
{
  class Module 
  {
  public:
    enum ModuleStatus {
      eOkay = 0,
      eNotInitialized = 1,
      eBadState = 2,
      eFatalError = 3
    };

  protected:

    Module(const std::string& name, bool deleteOnExit=true, bool autoRegister=true);

  public:
    virtual ~Module();

  public:

    const std::string& getName() const {
      return m_name;
    }

    const ModuleStatus getStatus() const {
      return m_status;
    }

    virtual void initialize() 
    {;}

    virtual void reset() 
    {;}

    virtual void cleanup() 
    {;}

    bool deleteOnExit()
    {
      return m_deleteOnExit;
    }

    LogStream& log()
    {
      return m_log;
    }

    virtual void beginEvent( const G4Event* )
    {;}

    virtual void endEvent( const G4Event* )
    {;}

    virtual void beginRun( const G4Run* )
    {;}

    virtual void endRun( const G4Run* )
    {;}

    virtual void preTracking( const G4Track* )
    {;}

    virtual void postTracking( const G4Track* )
    {;}    

    virtual void stepping( const G4Step* ) 
    {;}

    G4ClassificationOfNewTrack stackingClassifyNewTrack( const G4Track* )
    {
      G4Exception("This method should never be called.  Please override it.");
      // Arbitrary return value.  Will never reach here.
      return fWaiting;
    }
    
    void stackingNewStage()
    {;}

    void stackingPrepareNewEvent()
    {;}

  public:
    ModuleStatus m_status;
    std::string m_name;
    LogStream m_log;
    bool m_deleteOnExit;
  };
}

#endif

---