Geant4  10.03
G4SmartVoxelProxy.hh
Go to the documentation of this file.
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: G4SmartVoxelProxy.hh 66356 2012-12-18 09:02:32Z gcosmo $
28 //
29 // class G4SmartVoxelProxy
30 //
31 // Class description:
32 //
33 // Class for proxying smart voxels. The class represents either a header
34 // (in turn refering to more VoxelProxies) or a node. If created as a node,
35 // calls to GetHeader cause an exception, and likewise GetNode when a header.
36 //
37 // Note that the proxy does NOT gain deletion responsibility for proxied
38 // objects.
39 
40 // History:
41 // 12.07.95 P.Kent Initial version
42 // 03.08.95 P.Kent Updated to become non abstract class, removing
43 // HeaderProxy and NodeProxy derived classes
44 // --------------------------------------------------------------------
45 #ifndef G4SMARTVOXELPROXY_HH
46 #define G4SMARTVOXELPROXY_HH
47 
48 #include "G4Types.hh"
49 #include <assert.h>
50 
51 class G4SmartVoxelNode;
52 class G4SmartVoxelHeader;
53 
55 {
56 
57  public: // with description
58 
60  : fHeader(pHeader), fNode(0) {}
61  // Proxy for the specified header.
62 
64  : fHeader(0), fNode(pNode) {}
65  // Proxy for the specified node.
66 
68  // Destructor - do nothing. Not responsible for proxied objects.
69 
70  G4bool IsHeader() const;
71  // Return true if proxying for a header, else false.
72 
73  G4bool IsNode() const;
74  // Return true if proxying for a node, else false.
75 
76  G4SmartVoxelNode* GetNode() const;
77  // Return ptr to proxied node, else call G4Exception.
78 
80  // Return ptr to proxied header, else call G4Exception
81 
82  G4bool operator == (const G4SmartVoxelProxy& v) const;
83  // Equality operator.
84  // True when objects share same address.
85 
86  private:
87 
90 };
91 
92 #include "G4SmartVoxelProxy.icc"
93 
94 #endif
G4SmartVoxelHeader * GetHeader() const
G4bool operator==(const G4SmartVoxelProxy &v) const
G4bool IsNode() const
G4SmartVoxelProxy(G4SmartVoxelHeader *pHeader)
bool G4bool
Definition: G4Types.hh:79
G4SmartVoxelNode * fNode
G4SmartVoxelHeader * fHeader
G4SmartVoxelNode * GetNode() const
G4bool IsHeader() const
G4SmartVoxelProxy(G4SmartVoxelNode *pNode)