source: trunk/source/geometry/management/include/G4PhysicalVolumeStore.hh@ 1044

Last change on this file since 1044 was 850, checked in by garnier, 17 years ago

geant4.8.2 beta

File size: 3.9 KB
Line 
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: G4PhysicalVolumeStore.hh,v 1.16 2008/07/10 09:41:20 gcosmo Exp $
28// GEANT4 tag $Name: HEAD $
29//
30// class G4PhysicalVolume
31//
32// Class description:
33//
34// Container for all solids, with functionality derived from
35// std::vector<T>. The class is a `singleton', in that only
36// one can exist, and access is provided via the static method
37// G4PhysicalVolumeStore::GetInstance()
38//
39// All solids should be registered with G4PhysicalVolumeStore, and removed on
40// their destruction. Intended principally for UI browser. The underlying
41// container initially has a capacity of 100.
42//
43// If much additional functionality is added, should consider containment
44// instead of inheritance for std::vector<T>
45//
46// Member data:
47//
48// static G4PhysicalVolumeStore*
49// - Ptr to the single G4PhysicalVolumeStore.
50
51// History:
52// 18.04.01 G.Cosmo Migrated to STL vector
53// 25.07.95 P.Kent Initial version
54// --------------------------------------------------------------------
55#ifndef G4PHYSICALVOLUMESTORE_HH
56#define G4PHYSICALVOLUMESTORE_HH
57
58#include <vector>
59
60#include "G4VPhysicalVolume.hh"
61#include "G4VStoreNotifier.hh"
62
63class G4PhysicalVolumeStore : public std::vector<G4VPhysicalVolume*>
64{
65 public: // with description
66
67 static void Register(G4VPhysicalVolume* pSolid);
68 // Add the volume to the collection.
69 static void DeRegister(G4VPhysicalVolume* pSolid);
70 // Remove the volume from the collection.
71 static G4PhysicalVolumeStore* GetInstance();
72 // Get a ptr to the unique G4PhysicalVolumeStore, creating it if necessary.
73 static void SetNotifier(G4VStoreNotifier* pNotifier);
74 // Assign a notifier for allocation/deallocation of the physical volumes.
75 static void Clean();
76 // Delete all physical volumes from the store. Mother logical volumes
77 // are automatically notified and have their daughters de-registered.
78
79 G4VPhysicalVolume* GetVolume(const G4String& name,
80 G4bool verbose=true) const;
81 // Return the pointer of the first volume in the collection having
82 // that name.
83
84 virtual ~G4PhysicalVolumeStore();
85 // Destructor: takes care to delete allocated physical volumes.
86
87 protected:
88
89 G4PhysicalVolumeStore();
90
91 private:
92
93 static G4PhysicalVolumeStore* fgInstance;
94 static G4VStoreNotifier* fgNotifier;
95 static G4bool locked;
96};
97
98#endif
Note: See TracBrowser for help on using the repository browser.