Geant4_10
G4SolidStore.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: G4SolidStore.hh 66872 2013-01-15 01:25:57Z japost $
28 //
29 // class G4SolidStore
30 //
31 // Class description:
32 //
33 // Container for all solids, with functionality derived from
34 // std::vector<T>. The class is a `singleton', in that only
35 // one can exist, and access is provided via the static method
36 // G4SolidStore::GetInstance().
37 //
38 // All solids should be registered with G4SolidStore, and removed on their
39 // destruction. Intended principally for UI browser. The underlying
40 // container initially has a capacity of 100.
41 //
42 // If much additional functionality is added, should consider containment
43 // instead of inheritance for std::vector<T>
44 //
45 // Member data:
46 //
47 // static G4SolidStore*
48 // - Ptr to the single G4SolidStore
49 
50 // History:
51 // 18.04.01 G.Cosmo Migrated to STL vector
52 // 10.07.95 P.Kent Initial version
53 // --------------------------------------------------------------------
54 #ifndef G4VSOLIDSTORE_HH
55 #define G4VSOLIDSTORE_HH
56 
57 #include <vector>
58 
59 #include "G4VSolid.hh"
60 #include "G4VStoreNotifier.hh"
61 
62 class G4SolidStore : public std::vector<G4VSolid*>
63 {
64  public: // with description
65 
66  static void Register(G4VSolid* pSolid);
67  // Add the solid to the collection.
68  static void DeRegister(G4VSolid* pSolid);
69  // Remove the solid from the collection.
70  static G4SolidStore* GetInstance();
71  // Get a ptr to the unique G4SolidStore, creating it if necessary.
72  static void SetNotifier(G4VStoreNotifier* pNotifier);
73  // Assign a notifier for allocation/deallocation of solids.
74  static void Clean();
75  // Delete all solids from the store.
76 
77  G4VSolid* GetSolid(const G4String& name, G4bool verbose=true) const;
78  // Return the pointer of the first solid in the collection having
79  // that name.
80 
81  virtual ~G4SolidStore();
82  // Destructor: takes care to delete allocated solids.
83 
84  protected:
85 
86  G4SolidStore();
87 
88  private:
89 
90  static G4SolidStore* fgInstance;
91  static G4ThreadLocal G4VStoreNotifier* fgNotifier;
92  static G4ThreadLocal G4bool locked;
93 };
94 
95 #endif
G4VSolid * GetSolid(const G4String &name, G4bool verbose=true) const
static void SetNotifier(G4VStoreNotifier *pNotifier)
static void Register(G4VSolid *pSolid)
static void DeRegister(G4VSolid *pSolid)
static void Clean()
Definition: G4SolidStore.cc:79
const XML_Char * name
Definition: expat.h:151
#define G4ThreadLocal
Definition: tls.hh:52
bool G4bool
Definition: G4Types.hh:79
static G4SolidStore * GetInstance()
virtual ~G4SolidStore()
Definition: G4SolidStore.cc:64