| 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: G4BlockingList.hh,v 1.4 2006/06/29 18:30:41 gunter Exp $
|
|---|
| 28 | // GEANT4 tag $Name: HEAD $
|
|---|
| 29 | //
|
|---|
| 30 | // class G4BlockingList
|
|---|
| 31 | //
|
|---|
| 32 | // Class description:
|
|---|
| 33 | //
|
|---|
| 34 | // A utility class responsible for (efficiently) maintaining a List
|
|---|
| 35 | // of blocked volume numbers, with rapid `reset' operations.
|
|---|
| 36 | //
|
|---|
| 37 | // Notes:
|
|---|
| 38 | //
|
|---|
| 39 | // Implemented via a ValVector of ints: a tag value is used to set
|
|---|
| 40 | // the indices of blocked volumes. On reset the current tag value is
|
|---|
| 41 | // increased, so that the ValVector must only be zeroed when the
|
|---|
| 42 | // numerical range of the tag is used.
|
|---|
| 43 |
|
|---|
| 44 | // History:
|
|---|
| 45 | //
|
|---|
| 46 | // 24.7.96 P.Kent Separated from G4Navigator
|
|---|
| 47 | // --------------------------------------------------------------------
|
|---|
| 48 | #ifndef G4BLOCKINGLIST_HH
|
|---|
| 49 | #define G4BLOCKINGLIST_HH
|
|---|
| 50 |
|
|---|
| 51 | #include "G4Types.hh"
|
|---|
| 52 | #include <vector>
|
|---|
| 53 |
|
|---|
| 54 | const G4int kBlockingListMaxDefault = 500; // Block up to 511 daughters
|
|---|
| 55 | // initially
|
|---|
| 56 | const G4int kBlockingListStride = 128;
|
|---|
| 57 | const G4int kBlockTagNoMax = 2147483647; // 2^31-1 maximum tag no may reach
|
|---|
| 58 |
|
|---|
| 59 | class G4BlockingList
|
|---|
| 60 | {
|
|---|
| 61 | public: // with description
|
|---|
| 62 |
|
|---|
| 63 | G4BlockingList(G4int maxDefault=kBlockingListMaxDefault,
|
|---|
| 64 | G4int stride=kBlockingListStride);
|
|---|
| 65 | // Create empty blocking List of default size and `stride' resize count.
|
|---|
| 66 |
|
|---|
| 67 | ~G4BlockingList();
|
|---|
| 68 | // Destructor. No operations.
|
|---|
| 69 |
|
|---|
| 70 | void Reset();
|
|---|
| 71 | // Efficiently `Reset' the blocking List, so that no volumes
|
|---|
| 72 | // are blocked [Advance tag number and only fully clear List
|
|---|
| 73 | // if tag max reached]
|
|---|
| 74 |
|
|---|
| 75 | void FullyReset();
|
|---|
| 76 | // Clear the blocking List and reset tag value [slow].
|
|---|
| 77 |
|
|---|
| 78 | void Enlarge(const G4int nv);
|
|---|
| 79 | // Enlarges blocking List if current size < nv, in units of stride.
|
|---|
| 80 | // Clears the new part of the List.
|
|---|
| 81 |
|
|---|
| 82 | G4int Length() const;
|
|---|
| 83 | // Returns the current length of the List. Note a length of 16
|
|---|
| 84 | // means volumes of indices between 0 & 15 inclusive may be blocked.
|
|---|
| 85 |
|
|---|
| 86 | void BlockVolume(const G4int v);
|
|---|
| 87 | // Block the volume number v.
|
|---|
| 88 | // Requires: 0<=v<Length().
|
|---|
| 89 |
|
|---|
| 90 | G4bool IsBlocked(const G4int v) const;
|
|---|
| 91 | // Return true if the volume number v is blocked, else false.
|
|---|
| 92 | // Requires: 0 <= v < Length().
|
|---|
| 93 |
|
|---|
| 94 | private:
|
|---|
| 95 |
|
|---|
| 96 | G4int fBlockTagNo, fStride;
|
|---|
| 97 | // Current blocked volume tag number.
|
|---|
| 98 |
|
|---|
| 99 | std::vector<G4int> fBlockingList;
|
|---|
| 100 | // Blocked volumes: Elements with indices
|
|---|
| 101 | // corresponding to blocked volume set to fBlockTagNo.
|
|---|
| 102 |
|
|---|
| 103 | };
|
|---|
| 104 |
|
|---|
| 105 | #include "G4BlockingList.icc"
|
|---|
| 106 |
|
|---|
| 107 | #endif
|
|---|
