Geant4  10.00.p03
G4AutoDelete.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 // $Id$
27 //
28 // ---------------------------------------------------------------
29 // GEANT 4 class header file
30 //
31 // Class Description:
32 // This function implements a simplified "garbage collection" mechanism
33 // for G4-MT model. Objects are registered when created on the heap and they
34 // will be deleted at the end of
35 // the program (like they would be if marked as "static").
36 //
37 // Limitation:
38 // The registered object, should not
39 // contain any G4ThreadLocal data member. Note that in general,
40 // if object is to be thread-private it is unnecessary to mark
41 // any data-member as G4ThreadLocal.
42 //
43 // Performance issues:
44 // This function uses G4ThreadLocalSingleton that on its own uses
45 // locks and mutexes. Thus its use should be limited to only when
46 // really necessary.
47 //
48 // Example:
49 // class G4SharedByThreads {
50 // void calledByThreads() {
51 // G4Something* anObject = new G4Something;
52 // G4AutoDelete::Register( anObject );
53 // }
54 // };
55 //
56 // History:
57 // 28 October 2013: A. Dotti - First implementation
58 
59 #ifndef G4AUTODELETE_HH
60 #define G4AUTODELETE_HH
61 
63 namespace G4AutoDelete {
64  template<class T>
65  void Register( T* inst ) {
66  static G4ThreadLocalSingleton<T> container;
67  container.Register(inst);
68  }
69 }
70 
71 #endif //G4AUTODELETE_HH
void Register(T *inst)
Definition: G4AutoDelete.hh:65