| 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 // This example is provided by the Geant4-DNA collaboration
27 // Any report or published results obtained using the Geant4-DNA software
28 // shall cite the following Geant4-DNA collaboration publication:
29 // Med. Phys. 37 (2010) 4692-4708
30 // The Geant4-DNA web site is available at http://geant4-dna.org
31 //
32 // Authors: Henri Payno and Yann Perrot
33 //
34 //
35 /// \file SBPoint.hh
36 /// \brief Definition of the SBPoint class
37
38 #ifndef SB_POINT_HH
39 #define SB_POINT_HH
40
41 #include <G4ThreeVector.hh>
42 #include <assert.h>
43
44 class ClusterSBPoints;
45 /// \brief defines a point of energy deposition which defines a damage to the DNA.
46 class SBPoint
47 {
48 public:
49 /// \brief constructor
50 SBPoint(unsigned int, G4ThreeVector pPos, G4double pEdep);
51 /// \brief destructor
52 ~SBPoint();
53
54 // Get methods
55 G4int GetID() const { return fId; }
56 G4ThreeVector GetPosition() const { return fPosition; }
57 G4double GetEdep() const { return fEdep; }
58 ClusterSBPoints* GetCluster() const { return fpCluster; }
59 G4int GetTouchedStrand() const { return fStrand; }
60
61 // Set methods
62 void SetCluster(ClusterSBPoints* pCluster)
63 {
64 assert(pCluster);
65 fpCluster = pCluster;
66 }
67
68 void SetPosition(G4ThreeVector pPos) { fPosition = pPos; }
69
70 bool HasCluster() const { return fpCluster != 0; }
71 void CleanCluster() { fpCluster = 0; }
72
73 bool operator!=(const SBPoint&) const;
74 bool operator==(const SBPoint&) const;
75 bool operator<(const SBPoint&) const;
76 bool operator>(const SBPoint&) const;
77
78 private:
79 unsigned int fId; // ID
80 G4ThreeVector fPosition; // Position
81 G4double fEdep; // Edp
82 ClusterSBPoints* fpCluster; // Associated clustered points
83 G4int fStrand; // Strand
84 };
85
86 #endif // SB_POINT_HH
87