DGtal  0.9.2
CowPtr.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 CowPtr.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 CowPtr.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::CowPtr<T>::selfDisplay ( std::ostream & out ) const
53 {
54  out << "[CowPtr " << myPtr << " ]";
55 }
56 
57 /**
58  * Checks the validity/consistency of the object.
59  * @return 'true' if the object is valid, 'false' otherwise.
60  */
61 template <typename T>
62 inline
63 bool
64 DGtal::CowPtr<T>::isValid() const
65 {
66  return myPtr.isValid();
67 }
68 
69 
70 
71 ///////////////////////////////////////////////////////////////////////////////
72 // Implementation of inline functions //
73 
74 template <typename T>
75 inline
76 std::ostream&
77 DGtal::operator<< ( std::ostream & out,
78  const CowPtr<T> & object )
79 {
80  object.selfDisplay( out );
81  return out;
82 }
83 
84 // //
85 ///////////////////////////////////////////////////////////////////////////////
86 
87