clustering/include/SBPoint.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // This example is provided by the Geant4-DNA collaboration
0027 // Any report or published results obtained using the Geant4-DNA software
0028 // shall cite the following Geant4-DNA collaboration publication:
0029 // Med. Phys. 37 (2010) 4692-4708
0030 // The Geant4-DNA web site is available at http://geant4-dna.org
0031 //
0032 // Authors: Henri Payno and Yann Perrot
0033 //
0034 //
0035 /// \file SBPoint.hh
0036 /// \brief Definition of the SBPoint class
0037
0038 #ifndef SB_POINT_HH
0039 #define SB_POINT_HH
0040
0041 #include <G4ThreeVector.hh>
0042 #include <assert.h>
0043
0044 class ClusterSBPoints;
0045 /// \brief defines a point of energy deposition which defines a damage to the DNA.
0046 class SBPoint
0047 {
0048   public:
0049     /// \brief constructor
0050     SBPoint(unsigned int, G4ThreeVector pPos, G4double pEdep);
0051     /// \brief destructor
0052     ~SBPoint();
0053
0054     // Get methods
0055     G4int GetID() const { return fId; }
0056     G4ThreeVector GetPosition() const { return fPosition; }
0057     G4double GetEdep() const { return fEdep; }
0058     ClusterSBPoints* GetCluster() const { return fpCluster; }
0059     G4int GetTouchedStrand() const { return fStrand; }
0060
0061     // Set methods
0062     void SetCluster(ClusterSBPoints* pCluster)
0063     {
0064       assert(pCluster);
0065       fpCluster = pCluster;
0066     }
0067
0068     void SetPosition(G4ThreeVector pPos) { fPosition = pPos; }
0069
0070     bool HasCluster() const { return fpCluster != 0; }
0071     void CleanCluster() { fpCluster = 0; }
0072
0073     bool operator!=(const SBPoint&) const;
0074     bool operator==(const SBPoint&) const;
0075     bool operator<(const SBPoint&) const;
0076     bool operator>(const SBPoint&) const;
0077
0078   private:
0079     unsigned int fId;  // ID
0080     G4ThreeVector fPosition;  // Position
0081     G4double fEdep;  // Edp
0082     ClusterSBPoints* fpCluster;  // Associated clustered points
0083     G4int fStrand;  // Strand
0084 };
0085
0086 #endif  // SB_POINT_HH