ug4
owned_pointer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2015: G-CSC, Goethe University Frankfurt
3  * Author: Sebastian Reiter
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__UG__owned_pointer__
34 #define __H__UG__owned_pointer__
35 
36 namespace ug
37 {
38 
41 
43 
61 template <class T>
62 class OwnedPtr
63 {
64  public:
65  typedef T* TPtr;
66  typedef T& TRef;
67 
68  OwnedPtr(TPtr p = 0) : m_p(p) {}
69 
71 
73  OwnedPtr(const OwnedPtr& op)
74  {
75  m_p = op.get();
76  op.invalidate();
77  }
78 
80 
83  {
84  reset(op.get());
85  op.invalidate();
86  return *this;
87  }
88 
89  void reset(TPtr p = 0) {if(m_p) delete m_p; m_p = p;}
90 
91  TPtr operator ->() const {return m_p;}
92  TRef operator *() const {return *m_p;}
93 
94  TPtr& get() const {return m_p;}
95 
96  operator bool() const {return m_p != 0;}
97 
98  private:
100  void invalidate() const {m_p = 0;}
101 
102  private:
103  mutable TPtr m_p;
104 };
105 
106 // end group ugbase_common_util
108 
109 }// end of namespace
110 
111 #endif
parameterString p
Holds and automatically deletes a pointer, similar to std::auto_ptr. USE WITH CARE!
Definition: owned_pointer.h:63
TPtr m_p
Definition: owned_pointer.h:103
T * TPtr
Definition: owned_pointer.h:65
OwnedPtr & operator=(const OwnedPtr &op)
Transfers ownership of the associated object from ap to this.
Definition: owned_pointer.h:82
OwnedPtr(const OwnedPtr &op)
Transfers ownership of the associated object from ap to this.
Definition: owned_pointer.h:73
TPtr operator->() const
Definition: owned_pointer.h:91
TRef operator*() const
Definition: owned_pointer.h:92
void invalidate() const
This method is a hack, to allow that only one instance owns the pointer.
Definition: owned_pointer.h:100
TPtr & get() const
Definition: owned_pointer.h:94
OwnedPtr(TPtr p=0)
Definition: owned_pointer.h:68
void reset(TPtr p=0)
Definition: owned_pointer.h:89
T & TRef
Definition: owned_pointer.h:66
the ug namespace