include/Geant4/G4VDigitizerModule.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 // G4VDigitizerModule
0027 //
0028 // class description:
0029 //
0030 // This is the abstract base class of the digitizer module. The user's
0031 // digitizer module which generates digits must be derived from this
0032 // class.
0033 // In the derived class constructor, name(s) of digi collection(s) which
0034 // are made by the digitizer module must be set to "collectionName" string
0035 // vector.
0036
0037 // Author: M.Asai
0038 // --------------------------------------------------------------------
0039 #ifndef G4VDigitizerModule_hh
0040 #define G4VDigitizerModule_hh 1
0041
0042 #include "globals.hh"
0043 #include <vector>
0044
0045 class G4DigiManager;
0046 class G4VDigiCollection;
0047
0048 class G4VDigitizerModule
0049 {
0050   public: // with description
0051
0052     G4VDigitizerModule(const G4String& modName);
0053     // Constructor. The user's concrete class must use this constructor
0054     // by the constructor initializer of the derived class. The name of
0055     // the detector module must be unique.
0056
0057     virtual ~G4VDigitizerModule();
0058     G4bool operator==(const G4VDigitizerModule& right) const;
0059     G4bool operator!=(const G4VDigitizerModule& right) const;
0060
0061     virtual void Digitize() = 0;
0062     //  The pure virtual method that the derived class must implement.
0063     // In the concrete implementation of this method, necessary digi
0064     // collection object must be constructed and set to G4DCofThisEvent
0065     // by StoreDigiCollection protected method.
0066
0067   public:
0068
0069     inline G4int GetNumberOfCollections() const
0070     { return G4int(collectionName.size()); }
0071     inline G4String GetCollectionName(G4int i) const
0072     { return collectionName[i]; }
0073     inline G4String GetName() const
0074     { return moduleName; }
0075     inline void SetVerboseLevel(G4int val)
0076     { verboseLevel = val; }
0077
0078   protected:
0079
0080     void StoreDigiCollection(G4VDigiCollection* aDC);
0081     void StoreDigiCollection(G4int DCID,G4VDigiCollection* aDC);
0082
0083   protected:
0084
0085     G4DigiManager* DigiManager;
0086     G4String moduleName;
0087     std::vector<G4String> collectionName;
0088     G4int verboseLevel;
0089 };
0090
0091 #endif