include/Geant4/G4RegularNavigationHelper.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 // class G4RegularNavigationHelper
0027 //
0028 // Class description:
0029 //
0030 // Utility class for navigation on regular structures, providing step
0031 // lengths counting for each regular voxel of the structure.
0032
0033 // Author: Pedro Arce, November 2008
0034 // --------------------------------------------------------------------
0035 #ifndef G4RegularNavigationHelper_HH
0036 #define G4RegularNavigationHelper_HH
0037
0038 #include <vector>
0039 #include "globals.hh"
0040 #include "G4ThreadLocalSingleton.hh"
0041
0042 using G4RegularNavigationHelper_theStepLengths_t =
0043       std::vector< std::pair<G4int,G4double> >;
0044
0045 class G4RegularNavigationHelper
0046 {
0047   friend class G4ThreadLocalSingleton<G4RegularNavigationHelper>;
0048
0049   public:
0050
0051     static G4RegularNavigationHelper* Instance();
0052    ~G4RegularNavigationHelper();
0053
0054     void ClearStepLengths();
0055     void AddStepLength( G4int copyNo, G4double slen );
0056     const std::vector< std::pair<G4int,G4double> > & GetStepLengths();
0057
0058     std::vector< std::pair<G4int,G4double> > theStepLengths;
0059
0060   private:
0061
0062     G4RegularNavigationHelper();
0063 };
0064
0065 #endif