itk::ThreadLogger Class Reference

#include <itkThreadLogger.h>

Inheritance diagram for itk::ThreadLogger:

Collaboration diagram for itk::ThreadLogger:

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 40 of file itkThreadLogger.h.

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	PriorityLevelType = Logger::PriorityLevelType
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 >
enum	PriorityLevelType {   MUSTFLUSH = 0,   FATAL,   CRITICAL,   WARNING,   INFO,   DEBUG,   NOTSET }
using	Self = LoggerBase
using	Superclass = Object
enum	TimeStampFormatType {   REALVALUE = 0,   HUMANREADABLE }
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
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	Flush () override
virtual DelayType	GetDelay () const
PriorityLevelType	GetLevelForFlushing () const override
virtual const char *	GetNameOfClass () const
PriorityLevelType	GetPriorityLevel () const override
virtual void	SetDelay (DelayType delay)
void	SetLevelForFlushing (PriorityLevelType level) override
void	SetPriorityLevel (PriorityLevelType level) override
void	Write (PriorityLevelType level, std::string const &content) override
Public Member Functions inherited from itk::LoggerBase
virtual std::string	BuildFormattedEntry (PriorityLevelType 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)
virtual void	SetName (const char *_arg)
void	Warning (std::string const &message)
virtual void	SetTimeStampFormat (TimeStampFormatType _arg)
virtual const TimeStampFormatType &	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 *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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
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)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
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 flag)
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 ()
	~LoggerBase () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 Types
using	LevelContainerType = std::queue< PriorityLevelType >
using	MessageContainerType = std::queue< std::string >
using	OperationContainerType = std::queue< OperationType >
using	OutputContainerType = std::queue< OutputType::Pointer >

Private Member Functions
void	InternalFlush ()

Private Attributes
DelayType	m_Delay
LevelContainerType	m_LevelQ
MessageContainerType	m_MessageQ
std::mutex	m_Mutex
OperationContainerType	m_OperationQ
OutputContainerType	m_OutputQ
bool	m_TerminationRequested
std::thread	m_Thread

Additional Inherited Members
Protected Attributes inherited from itk::LoggerBase
RealTimeClock::Pointer	m_Clock
std::string	m_HumanReadableFormat
PriorityLevelType	m_LevelForFlushing
MultipleLogOutput::Pointer	m_Output
PriorityLevelType	m_PriorityLevel
TimeStampFormatType	m_TimeStampFormat
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

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

Definition at line 47 of file itkThreadLogger.h.

using itk::ThreadLogger::DelayType = unsigned int

Definition at line 59 of file itkThreadLogger.h.

using itk::ThreadLogger::LevelContainerType = std::queue< PriorityLevelType >

private

Definition at line 124 of file itkThreadLogger.h.

using itk::ThreadLogger::MessageContainerType = std::queue< std::string >

private

Definition at line 122 of file itkThreadLogger.h.

using itk::ThreadLogger::OperationContainerType = std::queue< OperationType >

private

Definition at line 120 of file itkThreadLogger.h.

using itk::ThreadLogger::OutputContainerType = std::queue< OutputType::Pointer >

private

Definition at line 126 of file itkThreadLogger.h.

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

Definition at line 55 of file itkThreadLogger.h.

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

Definition at line 46 of file itkThreadLogger.h.

using itk::ThreadLogger::PriorityLevelType = Logger::PriorityLevelType

Definition at line 57 of file itkThreadLogger.h.

using itk::ThreadLogger::Self = ThreadLogger

Definition at line 44 of file itkThreadLogger.h.

using itk::ThreadLogger::Superclass = Logger

Definition at line 45 of file itkThreadLogger.h.

Member Enumeration Documentation

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

itk::ThreadLogger::ThreadLogger ( )

protected

Constructor

itk::ThreadLogger::~ThreadLogger ( )

overrideprotected

Destructor

Member Function Documentation

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

overridevirtual

Registers another output stream with the multiple output.

Reimplemented from itk::LoggerBase.

virtual::itk::LightObject::Pointer itk::ThreadLogger::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Logger.

void itk::ThreadLogger::Flush ( )

overridevirtual

Reimplemented from itk::LoggerBase.

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.

PriorityLevelType itk::ThreadLogger::GetLevelForFlushing ( ) const

overridevirtual

Reimplemented from itk::LoggerBase.

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::Logger.

PriorityLevelType 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.

void itk::ThreadLogger::InternalFlush ( )

private

static Pointer itk::ThreadLogger::New ( )

static

New macro for creation of a Smart Pointer

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

overrideprotectedvirtual

Print contents of a ThreadLogger

Reimplemented from itk::LoggerBase.

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.

void itk::ThreadLogger::SetLevelForFlushing ( PriorityLevelType  level )

overridevirtual

Reimplemented from itk::LoggerBase.

void itk::ThreadLogger::SetPriorityLevel ( PriorityLevelType  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.

void itk::ThreadLogger::ThreadFunction ( )

protected

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

overridevirtual

Reimplemented from itk::LoggerBase.

Member Data Documentation

DelayType itk::ThreadLogger::m_Delay

private

Definition at line 142 of file itkThreadLogger.h.

LevelContainerType itk::ThreadLogger::m_LevelQ

private

Definition at line 136 of file itkThreadLogger.h.

MessageContainerType itk::ThreadLogger::m_MessageQ

private

Definition at line 134 of file itkThreadLogger.h.

std::mutex itk::ThreadLogger::m_Mutex

mutableprivate

Definition at line 140 of file itkThreadLogger.h.

OperationContainerType itk::ThreadLogger::m_OperationQ

private

Definition at line 132 of file itkThreadLogger.h.

OutputContainerType itk::ThreadLogger::m_OutputQ

private

Definition at line 138 of file itkThreadLogger.h.

bool itk::ThreadLogger::m_TerminationRequested

private

Definition at line 130 of file itkThreadLogger.h.

std::thread itk::ThreadLogger::m_Thread

private

Definition at line 128 of file itkThreadLogger.h.

---

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

• itkThreadLogger.h