#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

const char *	GetNameOfClass () const override

PriorityLevelEnum	GetPriorityLevel () const override

virtual void	SetDelay (DelayType delay)

void	SetLevelForFlushing (PriorityLevelEnum level) override

void	SetPriorityLevel (PriorityLevelEnum level) override

void	Write (PriorityLevelEnum level, std::string const &content) override

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::LoggerBase
virtual void	AddLogOutput (OutputType *output)

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 void	Flush ()

virtual PriorityLevelEnum	GetLevelForFlushing () const

virtual const char *	GetName () const

const char *	GetNameOfClass () const override

virtual PriorityLevelEnum	GetPriorityLevel () const

void	Info (std::string const &message)

virtual void	SetLevelForFlushing (PriorityLevelEnum level)

virtual void	SetName (const char *_arg)

virtual void	SetPriorityLevel (PriorityLevelEnum level)

void	Warning (std::string const &message)

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

virtual void	SetTimeStampFormat (const TimeStampFormatEnum _arg)

virtual const TimeStampFormatEnum &	GetTimeStampFormat () 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 *cmd) 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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 ()

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

virtual void	PrivateFlush ()

	~LoggerBase () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

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	PrintSelf (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< PriorityLevelEnum >	m_LevelQ {}

std::queue< std::string >	m_MessageQ {}

std::mutex	m_Mutex {}

std::queue< OperationType >	m_OperationQ {}

std::queue< OutputType::Pointer >	m_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

using itk::ThreadLogger::ConstPointer = SmartPointer<const Self>

Definition at line 47 of file itkThreadLogger.h.

◆ DelayType

using itk::ThreadLogger::DelayType = unsigned int

Definition at line 59 of file itkThreadLogger.h.

◆ OutputType

using itk::ThreadLogger::OutputType = Logger::OutputType

Definition at line 55 of file itkThreadLogger.h.

◆ Pointer

using itk::ThreadLogger::Pointer = SmartPointer<Self>

Definition at line 46 of file itkThreadLogger.h.

◆ PriorityLevelEnum

using itk::ThreadLogger::PriorityLevelEnum = Logger::PriorityLevelEnum

Definition at line 57 of file itkThreadLogger.h.

◆ Self

using itk::ThreadLogger::Self = ThreadLogger

Definition at line 44 of file itkThreadLogger.h.

◆ Superclass

using itk::ThreadLogger::Superclass = Logger

Definition at line 45 of file itkThreadLogger.h.

Member Enumeration Documentation

◆ OperationType

enum itk::ThreadLogger::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.

◆ GetNameOfClass()

const char * itk::ThreadLogger::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Logger.

◆ 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

◆ 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:

itkThreadLogger.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DelayType

◆ OutputType

◆ Pointer

◆ PriorityLevelEnum

◆ Self

◆ Superclass

Member Enumeration Documentation

◆ OperationType

Constructor & Destructor Documentation

◆ ThreadLogger()

◆ ~ThreadLogger()

Member Function Documentation

◆ AddLogOutput()

◆ Flush()

◆ GetDelay()

◆ GetLevelForFlushing()

◆ GetNameOfClass()

◆ GetPriorityLevel()

◆ InternalFlush()

◆ New()

◆ PrintSelf()

◆ SetDelay()

◆ SetLevelForFlushing()

◆ SetPriorityLevel()

◆ ThreadFunction()

◆ Write()

Member Data Documentation

◆ m_Delay

◆ m_LevelQ

◆ m_MessageQ

◆ m_Mutex

◆ m_OperationQ

◆ m_OutputQ

◆ m_TerminationRequested

◆ m_Thread