d5/df0/G4DigiManager_8hh_source.html

//

// ********************************************************************

// * License and Disclaimer                                           *

// *                                                                  *

// * The  Geant4 software  is  copyright of the Copyright Holders  of *

// * the Geant4 Collaboration.  It is provided  under  the terms  and *

// * conditions of the Geant4 Software License,  included in the file *

// * LICENSE and available at  http://cern.ch/geant4/license .  These *

// * include a list of copyright holders.                             *

// *                                                                  *

// * Neither the authors of this software system, nor their employing *

// * institutes,nor the agencies providing financial support for this *

// * work  make  any representation or  warranty, express or implied, *

// * regarding  this  software system or assume any liability for its *

// * use.  Please see the license in the file  LICENSE  and URL above *

// * for the full disclaimer and the limitation of liability.         *

// *                                                                  *

// * This  code  implementation is the result of  the  scientific and *

// * technical work of the GEANT4 collaboration.                      *

// * By using,  copying,  modifying or  distributing the software (or *

// * any work based  on the software)  you  agree  to acknowledge its *

// * use  in  resulting  scientific  publications,  and indicate your *

// * acceptance of all terms of the Geant4 Software license.          *

// ********************************************************************

//

// G4DigiManager

//

// class description:

//

// This is a singleton class which manages the digitizer modules.

// The user cannot access to the constructor. The pointer of the

// only existing object can be got via G4DigiManager::GetDMpointer()

// static method. The first invokation in the program makes the

// singleton object.


// Author: M.Asai

// --------------------------------------------------------------------

#ifndef G4DigiManager_hh

#define G4DigiManager_hh 1


#include "globals.hh"

class G4Event;

#include "G4VDigitizerModule.hh"

class G4VHitsCollection;

class G4VDigiCollection;

class G4DMmessenger;

#include "G4DCtable.hh"

class G4RunManager;

class G4SDManager;

#include <vector>


class G4DigiManager

{

  public: // with description


      static G4DigiManager* GetDMpointer();

      // Returns the pointer to the singleton object


      static G4DigiManager* GetDMpointerIfExist();


      ~G4DigiManager();


      G4DigiManager(const G4DigiManager&) = delete;

      G4DigiManager& operator=(const G4DigiManager&) = delete;


  public: // with description


      void AddNewModule(G4VDigitizerModule* DM);

      //  Registers the user's digitizer mudule. This method must be invoked when

      // the user construct his/her digitizer module(s).

      void Digitize(G4String mName);

      //  Invokes Digitize() method of specified digitizer module. This is a kind

      // of service method. The user can invoke Digitize() method of a particular

      // module without knowing the pointer of the module object. The argument

      // "mName" is the name of the module, which is defined at the constructor

      // of the concrete digitizer module.

      G4VDigitizerModule* FindDigitizerModule(G4String mName);

      //  Returns the pointer to the digitizer module object with the given name.

      // Null will be returned if the name is not defined.

      const G4VHitsCollection* GetHitsCollection(G4int HCID, G4int eventID = 0);

      const G4VDigiCollection* GetDigiCollection(G4int DCID, G4int eventID = 0);

      //  These two methods return the pointer to the hits and digi collection

      // object, respectively. "HCID" and "DCID" are the ID numbers of hits and

      // digi collections, which can be obtained vir the next two methods.

      //  If "eventID" is greater than zero, corresponding hits or digi collection

      // of "eventID" prevuois event is returned so that event overlap can be

      // handled. To do this, necessary number of events must be set to G4RunManager

      // by G4RunManager::SetNumberOfEventsToBeStored() method previously to the

      // event loop.

      G4int GetHitsCollectionID(G4String HCname);

      G4int GetDigiCollectionID(G4String DCname);

      //  Returns the ID number of hits and digi collections, respectively. "HCname"

      // and "DCname" can be the collection name if it is unique, or can be detector

      // or module name and the collection name connected by "/".

      void SetDigiCollection(G4int DCID, G4VDigiCollection* aDC);

      //  This method must exclusively used by the base class of G4VDigitizerModule.

      // To set digi collection, the user must use SetDigiCollection of G4VDigitizerModule.


  public:


      void SetVerboseLevel(G4int vl);

      void List() const;


      inline G4int GetVerboseLevel() const

      { return verboseLevel; }

      inline G4int GetCollectionCapacity() const

      { return DCtable->entries(); }

      inline G4int GetModuleCapacity() const

      { return G4int(DMtable.size()); }

      inline G4DCtable* GetDCtable() const

      { return DCtable; }

      inline void RestoreDCtable(G4DCtable* dc)

      {

        if(DCtable) delete DCtable;

        DCtable = dc;

      }


  protected:


      G4DigiManager();


  private:


      static G4ThreadLocal G4DigiManager * fDManager;

      G4int verboseLevel;

      std::vector<G4VDigitizerModule*> DMtable;

      G4DCtable* DCtable;

      G4DMmessenger* theMessenger;

      G4RunManager* runManager;

      G4SDManager* SDManager;

};


#endif