RSC  0.17.1
Printable.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is a part of the RSC project.
4  *
5  * Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <exception>
30 #include <map>
31 #include <ostream>
32 #include <set>
33 #include <vector>
34 
35 #include <boost/shared_ptr.hpp>
36 #include <boost/weak_ptr.hpp>
37 
38 #include "rsc/rscexports.h"
39 
40 namespace rsc {
41 namespace runtime {
42 
60 class RSC_EXPORT Printable {
61 public:
62 
63  virtual ~Printable();
64 
72  virtual std::string getClassName() const;
73 
80  virtual void printContents(std::ostream& stream) const;
81 
87  virtual void print(std::ostream& stream) const;
88 
89 };
90 
98 RSC_EXPORT std::ostream& operator<<(std::ostream& stream,
99  const Printable& printable);
100 
108 RSC_EXPORT std::ostream& operator<<(std::ostream& stream,
109  const Printable* printable);
110 
119 template<class Y>
120 std::ostream& operator<<(std::ostream& stream, boost::weak_ptr<Y> const & p) {
121  return stream << p.lock().get();
122 }
123 
124 }
125 }
ostream & operator<<(ostream &stream, const Printable &record)
Output operator on std::ostream for reference Printables.
Definition: Printable.cpp:56
A base class that defines utility functions for printing objects to streams.
Definition: Printable.h:60