itkLoggerBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkLoggerBase_h
#define itkLoggerBase_h

#include "itkMultipleLogOutput.h"
#include "itkRealTimeClock.h"

#ifdef DEBUG
#undef DEBUG // HDF5 publicly exports this define when built in debug mode
// That messes up the DEBUG enumeration in PriorityLevelType.
#endif

namespace itk
{
class ITKCommon_EXPORT LoggerBase:public Object
{
public:

  using Self = LoggerBase;
  using Superclass = Object;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(LoggerBase, Object);

  using OutputType = MultipleLogOutput::OutputType;

  typedef enum {
    MUSTFLUSH = 0,
    FATAL,
    CRITICAL,
    WARNING,
    INFO,
    DEBUG,
    NOTSET
    } PriorityLevelType;

  itkSetStringMacro(Name);
  itkGetStringMacro(Name);

  typedef enum {
    REALVALUE = 0,
    HUMANREADABLE
    } TimeStampFormatType;

  itkSetMacro(TimeStampFormat, TimeStampFormatType);
  itkGetConstReferenceMacro(TimeStampFormat, TimeStampFormatType);

  itkSetStringMacro(HumanReadableFormat);
  itkGetStringMacro(HumanReadableFormat);

  virtual std::string BuildFormattedEntry(PriorityLevelType level,
                                          std::string const & content);

  virtual void SetPriorityLevel(PriorityLevelType level)
  {
    m_PriorityLevel = level;
  }

  virtual PriorityLevelType GetPriorityLevel() const
  {
    return m_PriorityLevel;
  }

  virtual void SetLevelForFlushing(PriorityLevelType level)
  {
    m_LevelForFlushing = level;
  }

  virtual PriorityLevelType GetLevelForFlushing() const
  {
    return m_LevelForFlushing;
  }

  virtual void AddLogOutput(OutputType *output);

  virtual void Write(PriorityLevelType level, std::string const & content);

  void Debug(std::string const & message)
  {
    this->Write (LoggerBase::DEBUG, message);
  }

  void Info(std::string const & message)
  {
    this->Write (LoggerBase::INFO, message);
  }

  void Warning(std::string const & message)
  {
    this->Write (LoggerBase::WARNING, message);
  }

  void Critical(std::string const & message)
  {
    this->Write (LoggerBase::CRITICAL, message);
  }

  void Error(std::string const & message)
  {
    this->Write (LoggerBase::CRITICAL, message);
  }

  void Fatal(std::string const & message)
  {
    this->Write (LoggerBase::FATAL, message);
  }

  virtual void Flush();

protected:

  LoggerBase();

  ~LoggerBase() override;

  void PrintSelf(std::ostream & os, Indent indent) const override;

protected:

  PriorityLevelType m_PriorityLevel;

  PriorityLevelType m_LevelForFlushing;

  MultipleLogOutput::Pointer m_Output;

  RealTimeClock::Pointer m_Clock;

  TimeStampFormatType m_TimeStampFormat;

  std::string m_HumanReadableFormat;

private:

  std::string m_Name;
};  // class LoggerBase
} // namespace itk

#endif  // itkLoggerBase_h