| Geant4 Cross Reference |
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 // G4VDigitizerModule
27 //
28 // class description:
29 //
30 // This is the abstract base class of the digitizer module. The user's
31 // digitizer module which generates digits must be derived from this
32 // class.
33 // In the derived class constructor, name(s) of digi collection(s) which
34 // are made by the digitizer module must be set to "collectionName" string
35 // vector.
36
37 // Author: M.Asai
38 // --------------------------------------------------------------------
39 #ifndef G4VDigitizerModule_hh
40 #define G4VDigitizerModule_hh 1
41
42 #include "globals.hh"
43 #include <vector>
44
45 class G4DigiManager;
46 class G4VDigiCollection;
47
48 class G4VDigitizerModule
49 {
50 public: // with description
51
52 G4VDigitizerModule(const G4String& modName);
53 // Constructor. The user's concrete class must use this constructor
54 // by the constructor initializer of the derived class. The name of
55 // the detector module must be unique.
56
57 virtual ~G4VDigitizerModule();
58 G4bool operator==(const G4VDigitizerModule& right) const;
59 G4bool operator!=(const G4VDigitizerModule& right) const;
60
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 public:
68
69 inline G4int GetNumberOfCollections() const
70 { return G4int(collectionName.size()); }
71 inline const G4String& GetCollectionName(G4int i) const
72 { return collectionName[i]; }
73 inline const G4String& GetName() const
74 { return moduleName; }
75 inline void SetVerboseLevel(G4int val)
76 { verboseLevel = val; }
77
78 protected:
79
80 void StoreDigiCollection(G4VDigiCollection* aDC);
81 void StoreDigiCollection(G4int DCID,G4VDigiCollection* aDC);
82
83 protected:
84
85 G4DigiManager* DigiManager;
86 G4String moduleName;
87 std::vector<G4String> collectionName;
88 G4int verboseLevel;
89 };
90
91 #endif
92