Logger.h

Go to the documentation of this file.

/*
 * Karto(tm) Robot Navigation Software - Software Development Kit
 * Release 2.1
 *
 * Copyright (C) 2006-2011, SRI International (R)
 *
 * The material contained in this release is copyrighted. It may not be copied,
 * reproduced, translated, reverse engineered, modified or reduced to any electronic
 * medium or machine-readable form without the prior written consent of
 * SRI International (R).
 *
 * Portions of files in this release may be unpublished work
 * containing SRI International (R) CONFIDENTIAL AND PROPRIETARY INFORMATION.
 * Disclosure, use, reverse engineering, modification, or reproduction without
 * written authorization of SRI International (R) is likewise prohibited.
 *
 * Karto (tm) is a Trademark of SRI International (R).
 *
 * Author(s): Michael A. Eriksen (eriksen@ai.sri.com)
 */

#pragma once

#ifndef __KARTO_LOGGER__
#define __KARTO_LOGGER__

#include <OpenKarto/String.h>
#include <OpenKarto/Event.h>

namespace karto
{
  



  enum LogLevel 
  {
    LOG_NONE = 0,

    LOG_FATAL = 1,

    LOG_ERROR = 3,  

    LOG_WARNING = 4,  

    LOG_INFORMATION = 6, 

    LOG_DEBUG = 7    
  };

  extern KARTO_EXPORT void Log(LogLevel level, const karto::String& rMessage);

  extern KARTO_EXPORT LogLevel GetLogLevel();

  extern KARTO_EXPORT void SetLogLevel(LogLevel level);

  //@cond EXCLUDE
  void InitializeLogger(const karto::String& rApplicationName = "Karto", const String& rLogLevel = "NONE");

  void TerminateLogger();
  //@endcond
  

  class KARTO_EXPORT LogMessageArguments : public EventArguments
  {
  public:
    LogMessageArguments(LogLevel level, const karto::String& rMessage)
      : m_Level(level)
      , m_Message(rMessage)
    {
    }

    virtual ~LogMessageArguments()
    {
    }

  public:
    const LogLevel GetLevel() const
    {
      return m_Level;
    }

    const karto::String& GetMessage() const
    {
      return m_Message;
    }

  private:
    LogLevel m_Level;
    karto::String m_Message;
  };

#ifdef WIN32
  EXPORT_KARTO_EVENT(KARTO_EXPORT, LogMessageArguments)
#endif

  extern KARTO_EXPORT BasicEvent<LogMessageArguments> LogMessage;


}

#endif // __KARTO_LOGGER__