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: G4SmartVoxelNode.hh,v 1.12 2008/01/24 15:47:23 gcosmo Exp $ |
---|
28 | // GEANT4 tag $Name: geant4-09-04-beta-01 $ |
---|
29 | // |
---|
30 | // class G4SmartVoxelNode |
---|
31 | // |
---|
32 | // Class description: |
---|
33 | // |
---|
34 | // A node in the smart voxel hierarchy - a `slice' of space along a given |
---|
35 | // axis between given minima and maxima. Note that the node is not aware |
---|
36 | // of its position - this information being available/derivable by the |
---|
37 | // node's owner(s) (voxelheaders). |
---|
38 | // |
---|
39 | // Member Data: |
---|
40 | // |
---|
41 | // G4int fminEquivalent |
---|
42 | // G4int fmaxEquivalent |
---|
43 | // - Min and maximum nodes with same contents. Set by constructor |
---|
44 | // and set methods. |
---|
45 | // std::vector<G4int> fcontents |
---|
46 | // - Vector of no.s of volumes inside the node. |
---|
47 | |
---|
48 | // History: |
---|
49 | // 18.04.01 G.Cosmo Migrated to STL vector |
---|
50 | // 12.07.95 P.Kent Initial version |
---|
51 | // -------------------------------------------------------------------- |
---|
52 | #ifndef G4SMARTVOXELNODE_HH |
---|
53 | #define G4SMARTVOXELNODE_HH |
---|
54 | |
---|
55 | #include "G4Types.hh" |
---|
56 | #include <vector> |
---|
57 | |
---|
58 | typedef std::vector<G4int> G4SliceVector; |
---|
59 | |
---|
60 | class G4SmartVoxelNode |
---|
61 | { |
---|
62 | public: // with description |
---|
63 | |
---|
64 | G4SmartVoxelNode(G4int pSlice=0) : fminEquivalent(pSlice), |
---|
65 | fmaxEquivalent(pSlice) {} |
---|
66 | // Constructor. Create an empty node with slice number pSlice. |
---|
67 | // This number is not stored, but used to provide defaults for the |
---|
68 | // minimum and maximum equivalent node numbers. |
---|
69 | |
---|
70 | ~G4SmartVoxelNode(); |
---|
71 | // Destructor. No actions. |
---|
72 | |
---|
73 | inline G4int GetVolume(G4int pVolumeNo) const; |
---|
74 | // Return contained volume number pVolumeNo. |
---|
75 | // Note: starts from 0 and no bounds checking performed. |
---|
76 | |
---|
77 | inline void Insert(G4int pVolumeNo); |
---|
78 | // Add the specified volume number to the contents. |
---|
79 | |
---|
80 | inline G4int GetNoContained() const; |
---|
81 | // Return the number of volumes inside the node. |
---|
82 | |
---|
83 | inline G4int GetCapacity() const; |
---|
84 | // Return the maximum capacity of the buffer. |
---|
85 | |
---|
86 | inline void Reserve(G4int noSlices); |
---|
87 | // Reserve memory in the vector of slices according to the specified |
---|
88 | // quantity, relative to the maximum number of slices. |
---|
89 | |
---|
90 | inline void Shrink(); |
---|
91 | // Shrink buffer capacity to actual size to reduce wasted memory. |
---|
92 | |
---|
93 | inline G4int GetMaxEquivalentSliceNo() const; |
---|
94 | // Return the maximum slice (node/header) number with the same contents, |
---|
95 | // and with all intermediate slice also having the same contents. |
---|
96 | inline void SetMaxEquivalentSliceNo(G4int pMax); |
---|
97 | // Set the maximum slice number (as above). |
---|
98 | inline G4int GetMinEquivalentSliceNo() const; |
---|
99 | // Return the minimum slice (node/header) number with the same contents, |
---|
100 | // and with all intermediate nodes also having the same contents. |
---|
101 | inline void SetMinEquivalentSliceNo(G4int pMin); |
---|
102 | // Set the minimum slice number (as above). |
---|
103 | |
---|
104 | G4bool operator == (const G4SmartVoxelNode& v) const; |
---|
105 | // Equality operator. |
---|
106 | |
---|
107 | private: |
---|
108 | |
---|
109 | G4int fminEquivalent; |
---|
110 | G4int fmaxEquivalent; |
---|
111 | G4SliceVector fcontents; |
---|
112 | }; |
---|
113 | |
---|
114 | #include "G4SmartVoxelNode.icc" |
---|
115 | |
---|
116 | #endif |
---|