DGtal  0.9.2
CountedPtr.ih
1 /**
2  * This program is free software: you can redistribute it and/or modify
3  * it under the terms of the GNU Lesser General Public License as
4  * published by the Free Software Foundation, either version 3 of the
5  * License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program. If not, see <http://www.gnu.org/licenses/>.
14  *
15  **/
16 
17 /**
18  * @file CountedPtr.ih
19  * @author Jacques-Olivier Lachaud (\c jacques-olivier.lachaud@univ-savoie.fr )
20  * Laboratory of Mathematics (CNRS, UMR 5807), University of Savoie, France
21  *
22  * @date 2010/07/08
23  *
24  * Implementation of inline methods defined in CountedPtr.h
25  *
26  * This file is part of the DGtal library.
27  */
28 
29 
30 //////////////////////////////////////////////////////////////////////////////
31 #include <cstdlib>
32 //////////////////////////////////////////////////////////////////////////////
33 
34 ///////////////////////////////////////////////////////////////////////////////
35 // IMPLEMENTATION of inline methods.
36 ///////////////////////////////////////////////////////////////////////////////
37 
38 ///////////////////////////////////////////////////////////////////////////////
39 // ----------------------- Standard services ------------------------------
40 
41 
42 ///////////////////////////////////////////////////////////////////////////////
43 // Interface - public :
44 
45 /**
46  * Writes/Displays the object on an output stream.
47  * @param out the output stream where the object is written.
48  */
49 template <typename T>
50 inline
51 void
52 DGtal::CountedPtr<T>::selfDisplay ( std::ostream & out ) const
53 {
54  if (isValid())
55  out << "[CountedPtr nbcounts=" << myCounter->count << "]";
56  else
57  out << "[CountedPtr to NULL]";
58 }
59 
60 /**
61  * Checks the validity/consistency of the object.
62  * @return 'true' if the object is valid, 'false' otherwise.
63  */
64 template <typename T>
65 inline
66 bool
67 DGtal::CountedPtr<T>::isValid() const
68 {
69  return myCounter;
70 }
71 
72 
73 
74 ///////////////////////////////////////////////////////////////////////////////
75 // Implementation of inline functions //
76 
77 template <typename T>
78 inline
79 std::ostream&
80 DGtal::operator<< ( std::ostream & out,
81  const CountedPtr<T> & object )
82 {
83  object.selfDisplay( out );
84  return out;
85 }
86 
87 // //
88 ///////////////////////////////////////////////////////////////////////////////
89 
90