ogre_logging.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #include <OgreLogManager.h>
31 #include <OgreLog.h>
32 
33 #include <ros/ros.h>
34 
36 
37 namespace rviz
38 {
39 class RosLogListener : public Ogre::LogListener
40 {
41 public:
42  RosLogListener() : min_lml(Ogre::LML_CRITICAL){};
43  ~RosLogListener() override
44  {
45  }
46 
47 #if OGRE_VERSION >= ((1 << 16) | (8 << 8))
48  void messageLogged(const Ogre::String& message,
49  Ogre::LogMessageLevel lml,
50  bool /*maskDebug*/,
51  const Ogre::String& /*logName*/,
52  bool& skipThisMessage) override
53  {
54  if (!skipThisMessage)
55  {
56  if (lml >= min_lml)
57  {
58  ROS_LOG((ros::console::levels::Level)(lml - 1), ROSCONSOLE_DEFAULT_NAME, "%s", message.c_str());
59  }
60  }
61  }
62 #else
63  virtual void messageLogged(const Ogre::String& message,
64  Ogre::LogMessageLevel lml,
65  bool maskDebug,
66  const Ogre::String& /*logName*/)
67  {
68  if (lml >= min_lml)
69  {
70  ROS_LOG((ros::console::levels::Level)(lml - 1), ROSCONSOLE_DEFAULT_NAME, "%s", message.c_str());
71  }
72  }
73 #endif
74  Ogre::LogMessageLevel min_lml;
75 };
76 
79 
82 {
83  preference_ = StandardOut;
84 }
85 
90 void OgreLogging::useLogFile(const QString& filename)
91 {
92  preference_ = FileLogging;
93  filename_ = filename;
94 }
95 
98 {
99  preference_ = NoLogging;
100 }
101 
108 {
109  static RosLogListener ll;
110  Ogre::LogManager* log_manager = Ogre::LogManager::getSingletonPtr();
111  if (log_manager == nullptr)
112  {
113  log_manager = new Ogre::LogManager();
114  }
115  Ogre::Log* l = log_manager->createLog(filename_.toStdString(), false, false, preference_ == NoLogging);
116  l->addListener(&ll);
117 
118  // Printing to standard out is what Ogre does if you don't do any LogManager calls.
119  if (preference_ == StandardOut)
120  {
121  ll.min_lml = Ogre::LML_NORMAL;
122  }
123 }
124 
125 } // end namespace rviz
virtual void messageLogged(const Ogre::String &message, Ogre::LogMessageLevel lml, bool maskDebug, const Ogre::String &)
static void configureLogging()
Configure the Ogre::LogManager to give the currently selected behavior. This must be called before Og...
static QString filename_
Definition: ogre_logging.h:73
static void noLog()
Disable Ogre logging entirely. This is the default.
static void useLogFile(const QString &filename="Ogre.log")
Configure Ogre to write output to the given log file name. If file name is a relative path...
#define ROS_LOG(level, name,...)
~RosLogListener() override
#define ROSCONSOLE_DEFAULT_NAME
static Preference preference_
Definition: ogre_logging.h:72
static void useRosLog()
Configure Ogre to write output to the ROS logger.
Ogre::LogMessageLevel min_lml


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat May 27 2023 02:06:24