Geant4  10.02.p01
G4VDigitizerModule.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4VDigitizerModule.hh 80987 2014-05-19 10:50:22Z gcosmo $
28 //
29 
30 #ifndef G4VDigitizerModule_H
31 #define G4VDigitizerModule_H 1
32 
33 class G4DigiManager;
34 class G4VDigiCollection;
35 #include "globals.hh"
36 //#include "g4rw/tvordvec.h"
37 #include <vector>
38 
39 // class description:
40 //
41 // This is the abstract base class of the digitizer module. The user's
42 // digitizer module which generates digits must be derived from this
43 // class.
44 // In the derived class constructor, name(s) of digi collection(s) which
45 // are made by the digitizer module must be set to "collectionName" string
46 // vector.
47 
49 {
50  public: // with description
52  // Constructor. The user's concrete class must use this constructor
53  // by the constructor initializer of the derived class. The name of
54  // the detector module must be unique.
55  public:
56  virtual ~G4VDigitizerModule();
57  int operator==(const G4VDigitizerModule &right) const;
58  int operator!=(const G4VDigitizerModule &right) const;
59 
60  public: // with description
61  virtual void Digitize() = 0;
62  // The pure virtual method that the derived class must implement.
63  // In the concrete implementation of this method, necessary digi
64  // collection object must be constructed and set to G4DCofThisEvent
65  // by StoreDigiCollection protected method.
66 
67  protected:
70 
71  protected:
74  std::vector<G4String> collectionName;
76 
77  public:
79  { return collectionName.size(); }
81  { return collectionName[i]; }
82  inline G4String GetName() const
83  { return moduleName; }
84  inline void SetVerboseLevel(G4int val)
85  { verboseLevel = val; }
86 };
87 
88 #endif
89 
G4VDigitizerModule(G4String modName)
int operator==(const G4VDigitizerModule &right) const
int operator!=(const G4VDigitizerModule &right) const
virtual void Digitize()=0
int G4int
Definition: G4Types.hh:78
G4int GetNumberOfCollections() const
G4String GetName() const
G4String GetCollectionName(G4int i) const
G4DigiManager * DigiManager
void StoreDigiCollection(G4VDigiCollection *aDC)
void SetVerboseLevel(G4int val)
std::vector< G4String > collectionName