Program Listing for File ogre_logging.hpp

↰ Return to documentation for file (include/rviz_rendering/ogre_logging.hpp)

// Copyright (c) 2012, Willow Garage, Inc.
// Copyright (c) 2017, Open Source Robotics Foundation, Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//    * Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in the
//      documentation and/or other materials provided with the distribution.
//
//    * Neither the name of the copyright holder nor the names of its
//      contributors may be used to endorse or promote products derived from
//      this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.


#ifndef RVIZ_RENDERING__OGRE_LOGGING_HPP_
#define RVIZ_RENDERING__OGRE_LOGGING_HPP_

#include <memory>
#include <string>

#include "rviz_rendering/visibility_control.hpp"

namespace rviz_rendering
{


// forward declarations
class OgreLoggingPrivate;

class OgreLogging
{
public:
  RVIZ_RENDERING_PUBLIC
  static
  OgreLogging *
  get();

  ~OgreLogging();


  void
  useLogFile(const std::string & filename = "Ogre.log");


  RVIZ_RENDERING_PUBLIC
  void
  useLogFileAndStandardOut(const std::string & filename = "Ogre.log");

  void
  noLog();


  RVIZ_RENDERING_PUBLIC
  void
  configureLogging();

private:
  OgreLogging();

  static OgreLogging * instance_;
  typedef enum { StandardOut, FileLogging, NoLogging } Preference;
  Preference preference_ = OgreLogging::NoLogging;
  std::string filename_ = "Ogre.log";

  std::unique_ptr<OgreLoggingPrivate> dataPtr;
};

}  // namespace rviz_rendering

#endif  // RVIZ_RENDERING__OGRE_LOGGING_HPP_