Geant4  10.02.p01
G4VHit.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: G4VHit.hh 67992 2013-03-13 10:59:57Z gcosmo $
28 //
29 
30 #ifndef G4VHit_h
31 #define G4VHit_h 1
32 
33 #include "globals.hh"
34 #include <vector>
35 #include <map>
36 
37 class G4AttDef;
38 class G4AttValue;
39 
40 // class description:
41 //
42 // This is the base class of hit object. The user should derive this
43 // base class to make his/her own hit class. Two virtual method Draw()
44 // and Print() can be implemented if the user wants these functionarities.
45 // If a concrete hit class is used as a transient class, G4Allocator
46 // must be used.
47 
48 class G4VHit
49 {
50 
51  public:
52  G4VHit();
53  virtual ~G4VHit();
54 
55  G4int operator==(const G4VHit &right) const;
56 
57  virtual void Draw();
58  virtual void Print();
59 
60  virtual const std::map<G4String,G4AttDef>* GetAttDefs() const
61  { return 0; }
62  // If implemented by a derived class, returns a pointer to a map
63  // of attribute definitions for the attribute values below. The
64  // user must test the validity of this pointer. See
65  // G4Trajectory for an example of a concrete implementation of
66  // this method.
67  virtual std::vector<G4AttValue>* CreateAttValues() const
68  { return 0; }
69  // If implemented by a derived class, returns a pointer to a
70  // list of attribute values suitable, e.g., for picking. Each
71  // must refer to an attribute definition in the above map; its
72  // name is the key. The user must test the validity of this
73  // pointer (it must be non-zero and conform to the G4AttDefs,
74  // which may be checked with G4AttCheck) and delete the list
75  // after use. See G4Trajectory for an example of a concrete
76  // implementation of this method and
77  // G4VTrajectory::ShowTrajectory for an example of its use.
78 
79 };
80 
81 #endif
G4VHit()
Definition: G4VHit.cc:34
G4int operator==(const G4VHit &right) const
Definition: G4VHit.cc:40
Definition: G4VHit.hh:48
int G4int
Definition: G4Types.hh:78
virtual const std::map< G4String, G4AttDef > * GetAttDefs() const
Definition: G4VHit.hh:60
virtual void Print()
Definition: G4VHit.cc:46
virtual std::vector< G4AttValue > * CreateAttValues() const
Definition: G4VHit.hh:67
virtual ~G4VHit()
Definition: G4VHit.cc:37
virtual void Draw()
Definition: G4VHit.cc:43