itkLoggerManager.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkLoggerManager_h
#define itkLoggerManager_h
 
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkThreadLogger.h"
 
#include <string>
#include <map>
 
namespace itk
{
 
class ITKCommon_EXPORT LoggerManager : public Object
{
public:
  using Self = LoggerManager;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(LoggerManager);

  itkNewMacro(Self);
 
  using PriorityLevelEnum = Logger::PriorityLevelEnum;
 
  using OutputType = Logger::OutputType;
 
  using LoggerPointer = Logger::Pointer;
  using ThreadLoggerPointer = ThreadLogger::Pointer;
 
  using NameType = std::string;

  LoggerPointer
  CreateLogger(const NameType &  name,
               PriorityLevelEnum level,
               PriorityLevelEnum levelForFlushing = LoggerBase::PriorityLevelEnum::MUSTFLUSH);

  ThreadLoggerPointer
  CreateThreadLogger(const NameType &  name,
                     PriorityLevelEnum level,
                     PriorityLevelEnum levelForFlushing = LoggerBase::PriorityLevelEnum::MUSTFLUSH);

  void
  AddLogger(const NameType & name, Logger * logger);
 
  Logger *
  GetLogger(const NameType & name);
 
  void
  SetPriorityLevel(PriorityLevelEnum level);
 
  void
  SetLevelForFlushing(PriorityLevelEnum level);
 
  void
  AddLogOutput(OutputType * output);
 
  void
  Write(PriorityLevelEnum level, const std::string & content);
 
  void
  Flush();
 
protected:
  LoggerManager() = default;

  ~LoggerManager() override = default;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  std::map<NameType, LoggerPointer> m_LoggerSet{};
}; // class Logger
} // namespace itk
 
#endif // itkLoggerManager_h