SBPoint.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// This example is provided by the Geant4-DNA collaboration
// Any report or published results obtained using the Geant4-DNA software
// shall cite the following Geant4-DNA collaboration publication:
// Med. Phys. 37 (2010) 4692-4708
// The Geant4-DNA web site is available at http://geant4-dna.org
//
// Authors: Henri Payno and Yann Perrot
//
// $Id$
//

#ifndef SB_POINT_HH
#define SB_POINT_HH

#include <assert.h>
#include <G4ThreeVector.hh>

class ClusterSBPoints;
class SBPoint
{
public:
  SBPoint(unsigned int, G4ThreeVector pPos, G4double pEdep );
  ~SBPoint();

  // Get methods
  G4int GetID() const
  {
    return fId;
  }
  G4ThreeVector GetPosition() const {
    return fPosition;
  }
  G4double GetEdep() const {
    return fEdep;
  }
  ClusterSBPoints* GetCluster() const {
    return fpCluster;
  }
  G4int GetTouchedStrand() const {
    return fStrand;
  }

  // Set methods
  void SetCluster(ClusterSBPoints* pCluster)
  {
    assert(pCluster); fpCluster = pCluster;
  }

  void SetPosition(G4ThreeVector pPos)
  {
    fPosition=pPos;
  }

  bool HasCluster() const {
    return fpCluster != 0;
  }
  void CleanCluster() {
    fpCluster = 0;
  }

  bool operator != (const SBPoint& ) const;
  bool operator == (const SBPoint& ) const;
  bool operator < (const SBPoint& ) const;
  bool operator > (const SBPoint& ) const;

private:

  unsigned int fId;             //ID
  G4ThreeVector fPosition;      //Position
  G4double fEdep;               //Edp
  ClusterSBPoints* fpCluster;   // Associated clustered points
  G4int fStrand;                // Strand

};

#endif // SB_POINT_HH