ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::ThreadLogger Class Reference

#include <itkThreadLogger.h>

Detailed Description

Providing logging service as a separate thread.

Author
Hee-Su Kim, Compute Science Dept. Kyungpook National University, ISIS Center, Georgetown University.

Definition at line 41 of file itkThreadLogger.h.

+ Inheritance diagram for itk::ThreadLogger:
+ Collaboration diagram for itk::ThreadLogger:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DelayType = unsigned int
 
enum  OperationType {
  SET_PRIORITY_LEVEL,
  SET_LEVEL_FOR_FLUSHING,
  ADD_LOG_OUTPUT,
  WRITE,
  FLUSH
}
 
using OutputType = Logger::OutputType
 
using Pointer = SmartPointer< Self >
 
using PriorityLevelEnum = Logger::PriorityLevelEnum
 
using Self = ThreadLogger
 
using Superclass = Logger
 
- Public Types inherited from itk::Logger
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Logger
 
using Superclass = LoggerBase
 
- Public Types inherited from itk::LoggerBase
using ConstPointer = SmartPointer< const Self >
 
using OutputType = MultipleLogOutput::OutputType
 
using Pointer = SmartPointer< Self >
 
using PriorityLevelEnum = LoggerBaseEnums::PriorityLevel
 
using Self = LoggerBase
 
using Superclass = Object
 
using TimeStampFormatEnum = LoggerBaseEnums::TimeStampFormat
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void AddLogOutput (OutputType *output) override
 
void Flush () override
 
virtual DelayType GetDelay () const
 
PriorityLevelEnum GetLevelForFlushing () const override
 
PriorityLevelEnum GetPriorityLevel () const override
 
 itkOverrideGetNameOfClassMacro (ThreadLogger)
 
virtual void SetDelay (DelayType delay)
 
void SetLevelForFlushing (PriorityLevelEnum level) override
 
void SetPriorityLevel (PriorityLevelEnum level) override
 
void Write (PriorityLevelEnum level, std::string const &content) override
 
- Public Member Functions inherited from itk::Logger
 itkOverrideGetNameOfClassMacro (Logger)
 
- Public Member Functions inherited from itk::LoggerBase
virtual std::string BuildFormattedEntry (PriorityLevelEnum level, std::string const &content)
 
void Critical (std::string const &message)
 
void Debug (std::string const &message)
 
void Error (std::string const &message)
 
void Fatal (std::string const &message)
 
virtual const char * GetName () const
 
void Info (std::string const &message)
 
 itkOverrideGetNameOfClassMacro (LoggerBase)
 
virtual void SetName (const char *_arg)
 
void Warning (std::string const &message)
 
virtual void SetTimeStampFormat (const TimeStampFormatEnum _arg)
 
virtual const TimeStampFormatEnumGetTimeStampFormat () const
 
virtual void SetHumanReadableFormat (const char *_arg)
 
virtual const char * GetHumanReadableFormat () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Logger
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
void ThreadFunction ()
 
 ThreadLogger ()
 
 ~ThreadLogger () override
 
- Protected Member Functions inherited from itk::Logger
 Logger ()
 
 ~Logger () override
 
- Protected Member Functions inherited from itk::LoggerBase
 LoggerBase ()
 
virtual void PrivateFlush ()
 
 ~LoggerBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void InternalFlush ()
 

Private Attributes

DelayType m_Delay {}
 
std::queue< PriorityLevelEnumm_LevelQ {}
 
std::queue< std::string > m_MessageQ {}
 
std::mutex m_Mutex {}
 
std::queue< OperationTypem_OperationQ {}
 
std::queue< OutputType::Pointerm_OutputQ {}
 
std::atomic< bool > m_TerminationRequested {}
 
std::thread m_Thread {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LoggerBase
RealTimeClock::Pointer m_Clock {}
 
std::string m_HumanReadableFormat {}
 
PriorityLevelEnum m_LevelForFlushing {}
 
MultipleLogOutput::Pointer m_Output {}
 
PriorityLevelEnum m_PriorityLevel {}
 
TimeStampFormatEnum m_TimeStampFormat {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

Definition at line 47 of file itkThreadLogger.h.

◆ DelayType

using itk::ThreadLogger::DelayType = unsigned int

Definition at line 59 of file itkThreadLogger.h.

◆ OutputType

Definition at line 55 of file itkThreadLogger.h.

◆ Pointer

Definition at line 46 of file itkThreadLogger.h.

◆ PriorityLevelEnum

Definition at line 57 of file itkThreadLogger.h.

◆ Self

Definition at line 44 of file itkThreadLogger.h.

◆ Superclass

Definition at line 45 of file itkThreadLogger.h.

Member Enumeration Documentation

◆ OperationType

Definition of types of operations for ThreadLogger.

Enumerator
SET_PRIORITY_LEVEL 
SET_LEVEL_FOR_FLUSHING 
ADD_LOG_OUTPUT 
WRITE 
FLUSH 

Definition at line 62 of file itkThreadLogger.h.

Constructor & Destructor Documentation

◆ ThreadLogger()

itk::ThreadLogger::ThreadLogger ( )
protected

Constructor

◆ ~ThreadLogger()

itk::ThreadLogger::~ThreadLogger ( )
overrideprotected

Destructor

Member Function Documentation

◆ AddLogOutput()

void itk::ThreadLogger::AddLogOutput ( OutputType output)
overridevirtual

Registers another output stream with the multiple output.

Reimplemented from itk::LoggerBase.

◆ Flush()

void itk::ThreadLogger::Flush ( )
overridevirtual

Reimplemented from itk::LoggerBase.

◆ GetDelay()

virtual DelayType itk::ThreadLogger::GetDelay ( ) const
virtual

Get the delay in milliseconds between checks to see if there are any low priority messages to be processed.

◆ GetLevelForFlushing()

PriorityLevelEnum itk::ThreadLogger::GetLevelForFlushing ( ) const
overridevirtual

Reimplemented from itk::LoggerBase.

◆ GetPriorityLevel()

PriorityLevelEnum itk::ThreadLogger::GetPriorityLevel ( ) const
overridevirtual

Get the priority level for the current logger. Only messages that have priorities equal or greater than the one set here will be posted to the current outputs.

Reimplemented from itk::LoggerBase.

◆ InternalFlush()

void itk::ThreadLogger::InternalFlush ( )
private

◆ itkOverrideGetNameOfClassMacro()

itk::ThreadLogger::itkOverrideGetNameOfClassMacro ( ThreadLogger  )

Run-time type information (and related methods).

◆ New()

static Pointer itk::ThreadLogger::New ( )
static

New macro for creation of a Smart Pointer

◆ PrintSelf()

void itk::ThreadLogger::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Print contents of a ThreadLogger

Reimplemented from itk::LoggerBase.

◆ SetDelay()

virtual void itk::ThreadLogger::SetDelay ( DelayType  delay)
virtual

Set the delay in milliseconds between checks to see if there are any low priority messages to be processed.

◆ SetLevelForFlushing()

void itk::ThreadLogger::SetLevelForFlushing ( PriorityLevelEnum  level)
overridevirtual

Reimplemented from itk::LoggerBase.

◆ SetPriorityLevel()

void itk::ThreadLogger::SetPriorityLevel ( PriorityLevelEnum  level)
overridevirtual

Set the priority level for the current logger. Only messages that have priorities equal or greater than the one set here will be posted to the current outputs.

Reimplemented from itk::LoggerBase.

◆ ThreadFunction()

void itk::ThreadLogger::ThreadFunction ( )
protected

◆ Write()

void itk::ThreadLogger::Write ( PriorityLevelEnum  level,
std::string const &  content 
)
overridevirtual

Reimplemented from itk::LoggerBase.

Member Data Documentation

◆ m_Delay

DelayType itk::ThreadLogger::m_Delay {}
private

Definition at line 143 of file itkThreadLogger.h.

◆ m_LevelQ

std::queue<PriorityLevelEnum> itk::ThreadLogger::m_LevelQ {}
private

Definition at line 137 of file itkThreadLogger.h.

◆ m_MessageQ

std::queue<std::string> itk::ThreadLogger::m_MessageQ {}
private

Definition at line 135 of file itkThreadLogger.h.

◆ m_Mutex

std::mutex itk::ThreadLogger::m_Mutex {}
mutableprivate

Definition at line 141 of file itkThreadLogger.h.

◆ m_OperationQ

std::queue<OperationType> itk::ThreadLogger::m_OperationQ {}
private

Definition at line 133 of file itkThreadLogger.h.

◆ m_OutputQ

std::queue<OutputType::Pointer> itk::ThreadLogger::m_OutputQ {}
private

Definition at line 139 of file itkThreadLogger.h.

◆ m_TerminationRequested

std::atomic<bool> itk::ThreadLogger::m_TerminationRequested {}
private

Definition at line 131 of file itkThreadLogger.h.

◆ m_Thread

std::thread itk::ThreadLogger::m_Thread {}
private

Definition at line 129 of file itkThreadLogger.h.


The documentation for this class was generated from the following file: