RSC  0.16.0
LoggerProxy.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is a part of the RSC project.
4  *
5  * Copyright (C) 2011 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 <boost/enable_shared_from_this.hpp>
30 #include <boost/shared_ptr.hpp>
31 
32 #include "Logger.h"
33 
34 namespace rsc {
35 namespace logging {
36 
43 class LoggerProxy: public Logger, public boost::enable_shared_from_this<
44  LoggerProxy> {
45 public:
46 
58  public:
59  virtual ~SetLevelCallback();
60  virtual void call(boost::shared_ptr<LoggerProxy> proxy,
61  const Logger::Level& level) = 0;
62  };
63  typedef boost::shared_ptr<SetLevelCallback> SetLevelCallbackPtr;
64 
70  LoggerProxy(LoggerPtr logger, SetLevelCallbackPtr callback);
71  virtual ~LoggerProxy();
72 
77 
78  virtual Logger::Level getLevel() const;
79  virtual void setLevel(const Logger::Level& level);
80  virtual std::string getName() const;
81  virtual void setName(const std::string& name);
82  virtual void log(const Logger::Level& level, const std::string& msg);
83 
85 
90  LoggerPtr getLogger() const;
91 
99 
100 private:
101 
107 
108  SetLevelCallbackPtr callback;
109 
110 };
111 
112 typedef boost::shared_ptr<LoggerProxy> LoggerProxyPtr;
113 
114 }
115 }
virtual Logger::Level getLevel() const
Returns the currently defined level of the logger.
Definition: LoggerProxy.cpp:42
boost::shared_ptr< LoggerProxy > LoggerProxyPtr
Definition: LoggerProxy.h:112
SetLevelCallbackPtr callback
Definition: LoggerProxy.h:108
LoggerProxy(LoggerPtr logger, SetLevelCallbackPtr callback)
Constructor.
Definition: LoggerProxy.cpp:35
virtual void log(const Logger::Level &level, const std::string &msg)
Logs a message with the given level if it is enabled.
Definition: LoggerProxy.cpp:59
Level
Possible logging levels.
Definition: Logger.h:63
virtual void setLevel(const Logger::Level &level)
Defines the level of the logger.
Definition: LoggerProxy.cpp:46
void setLogger(LoggerPtr logger)
(Re-)Sets the logger to be hidden behind this proxy.
Definition: LoggerProxy.cpp:67
virtual void call(boost::shared_ptr< LoggerProxy > proxy, const Logger::Level &level)=0
A proxy to an instance of Logger, which provides the same interface but allows to exchange the underl...
Definition: LoggerProxy.h:43
virtual void setName(const std::string &name)
Sets the name of the logger.
Definition: LoggerProxy.cpp:55
virtual std::string getName() const
Returns the hierarchical name of the logger.
Definition: LoggerProxy.cpp:51
boost::shared_ptr< SetLevelCallback > SetLevelCallbackPtr
Definition: LoggerProxy.h:63
LoggerPtr getLogger() const
Returns the hidden logger behind this proxy.
Definition: LoggerProxy.cpp:63
Interface for callbacks which are invoked when someone calls setLevel on this proxy.
Definition: LoggerProxy.h:57
Interface for logging adapters that can be used with RSC.
Definition: Logger.h:54
LoggerPtr logger
The hidden logger.
Definition: LoggerProxy.h:106
boost::shared_ptr< Logger > LoggerPtr
Definition: Logger.h:41