| 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 // G4VHit
27 //
28 // Class description:
29 //
30 // This is the base class of hit object. The user should derive this
31 // base class to make his/her own hit class. Two virtual method Draw()
32 // and Print() can be implemented if the user wants these functionalities.
33 // If a concrete hit class is used as a transient class, G4Allocator
34 // must be used.
35 //
36 // Author: Makoto Asai
37 // --------------------------------------------------------------------
38 #ifndef G4VHit_h
39 #define G4VHit_h 1
40
41 #include "globals.hh"
42
43 #include <map>
44 #include <vector>
45
46 class G4AttDef;
47 class G4AttValue;
48
49 class G4VHit
50 {
51 public:
52
53 G4VHit() = default;
54 virtual ~G4VHit() = default;
55
56 G4bool operator==(const G4VHit&) const { return false; }
57
58 virtual void Draw() {}
59 virtual void Print() {}
60
61 // Returns pointer to map of attribute definitions for this hit
62 // Caller is responsible for checking validity of returned pointer.
63 // See `G4Trajectory` for a concrete implementation.
64 virtual const std::map<G4String, G4AttDef>* GetAttDefs() const { return nullptr; }
65
66 // Returns pointer to list of attributes for this hit
67 // Each attribute must correspond to a definition returned by `GetAffDefs`.
68 // Caller is responsible for checking validity of returned pointer.
69 // See `G4Trajectory` for a concrete implementation, and
70 // `G4VTrajectory::ShowTrajectory` for an example of its use.
71 virtual std::vector<G4AttValue>* CreateAttValues() const { return nullptr; }
72 };
73
74 #endif
75