#include <itkLoggerBase.h>

Detailed Description

Used for logging information during a run.

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

Definition at line 81 of file itkLoggerBase.h.

Inheritance diagram for itk::LoggerBase:

Collaboration diagram for itk::LoggerBase:

Public Types
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
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 void	Delete ()

virtual int	GetReferenceCount () const

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

Protected Member Functions
	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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
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 {}

Private Attributes
std::string	m_Name {}

Additional Inherited Members
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 ()

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 87 of file itkLoggerBase.h.

◆ OutputType

using itk::LoggerBase::OutputType = MultipleLogOutput::OutputType

Definition at line 92 of file itkLoggerBase.h.

◆ Pointer

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

Definition at line 86 of file itkLoggerBase.h.

◆ PriorityLevelEnum

using itk::LoggerBase::PriorityLevelEnum = LoggerBaseEnums::PriorityLevel

Definition at line 94 of file itkLoggerBase.h.

◆ Self

using itk::LoggerBase::Self = LoggerBase

Definition at line 84 of file itkLoggerBase.h.

◆ Superclass

using itk::LoggerBase::Superclass = Object

Definition at line 85 of file itkLoggerBase.h.

◆ TimeStampFormatEnum

using itk::LoggerBase::TimeStampFormatEnum = LoggerBaseEnums::TimeStampFormat

Definition at line 110 of file itkLoggerBase.h.

Constructor & Destructor Documentation

◆ LoggerBase()

itk::LoggerBase::LoggerBase ( )

protected

Constructor

◆ ~LoggerBase()

itk::LoggerBase::~LoggerBase ( )

overrideprotected

Destructor

Member Function Documentation

◆ AddLogOutput()

virtual void itk::LoggerBase::AddLogOutput ( OutputType * output )

virtual

Registers another output stream with the multiple output.

Reimplemented in itk::ThreadLogger.

◆ BuildFormattedEntry()

virtual std::string itk::LoggerBase::BuildFormattedEntry	(	PriorityLevelEnum	level,
		std::string const &	content
	)

virtual

Provides a default formatted log entry

◆ Critical()

void itk::LoggerBase::Critical ( std::string const & message )

inline

Definition at line 204 of file itkLoggerBase.h.

References itk::LoggerBaseEnums::CRITICAL.

◆ Debug()

void itk::LoggerBase::Debug ( std::string const & message )

inline

Helper methods

Definition at line 186 of file itkLoggerBase.h.

References itk::LoggerBaseEnums::DEBUG.

◆ Error()

void itk::LoggerBase::Error ( std::string const & message )

inline

Definition at line 210 of file itkLoggerBase.h.

References itk::LoggerBaseEnums::CRITICAL.

◆ Fatal()

void itk::LoggerBase::Fatal ( std::string const & message )

inline

Definition at line 216 of file itkLoggerBase.h.

References itk::LoggerBaseEnums::FATAL.

◆ Flush()

virtual void itk::LoggerBase::Flush ( )

virtual

Reimplemented in itk::ThreadLogger.

◆ GetHumanReadableFormat()

virtual const char* itk::LoggerBase::GetHumanReadableFormat ( ) const

virtual

Set/Get the specific text format to use when the time stamp format type is set to HUMANREADABLE. For a description of the acceptable formats please look at the man page of the strftime() method. The default is set to "%Y %b %d %H:%M:%S"

See also: SetTimeStampFormat

◆ GetLevelForFlushing()

virtual PriorityLevelEnum itk::LoggerBase::GetLevelForFlushing ( ) const

inlinevirtual

Reimplemented in itk::ThreadLogger.

Definition at line 172 of file itkLoggerBase.h.

◆ GetName()

virtual const char* itk::LoggerBase::GetName ( ) const

virtual

◆ GetNameOfClass()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Reimplemented in itk::ThreadLogger.

◆ GetPriorityLevel()

virtual PriorityLevelEnum itk::LoggerBase::GetPriorityLevel ( ) const

inlinevirtual

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

Definition at line 160 of file itkLoggerBase.h.

◆ GetTimeStampFormat()

virtual const TimeStampFormatEnum& itk::LoggerBase::GetTimeStampFormat ( ) const

virtual

Set/Get the type of format used for reporting the time stamp of a given log message. The main options are REALVALUE and HUMANREADABLE. REALVALUE will report the time in seconds as a double number. HUMANREADABLE will report the time in formatted text such as '2007 May 7 09:23:14'

See also: SetHumanReadableFormat()

◆ Info()

void itk::LoggerBase::Info ( std::string const & message )

inline

Definition at line 192 of file itkLoggerBase.h.

References itk::LoggerBaseEnums::INFO.

◆ PrintSelf()

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

overrideprotectedvirtual

Print contents of a LoggerBase

Reimplemented from itk::LightObject.

Reimplemented in itk::ThreadLogger.

◆ PrivateFlush()

virtual void itk::LoggerBase::PrivateFlush ( )

protectedvirtual

◆ SetHumanReadableFormat()

virtual void itk::LoggerBase::SetHumanReadableFormat ( const char * _arg )

virtual

Set/Get the specific text format to use when the time stamp format type is set to HUMANREADABLE. For a description of the acceptable formats please look at the man page of the strftime() method. The default is set to "%Y %b %d %H:%M:%S"

See also: SetTimeStampFormat

◆ SetLevelForFlushing()

virtual void itk::LoggerBase::SetLevelForFlushing ( PriorityLevelEnum level )

inlinevirtual

Reimplemented in itk::ThreadLogger.

Definition at line 166 of file itkLoggerBase.h.

◆ SetName()

virtual void itk::LoggerBase::SetName ( const char * _arg )

virtual

◆ SetPriorityLevel()

virtual void itk::LoggerBase::SetPriorityLevel ( PriorityLevelEnum level )

inlinevirtual

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

Definition at line 151 of file itkLoggerBase.h.

◆ SetTimeStampFormat()

virtual void itk::LoggerBase::SetTimeStampFormat ( const TimeStampFormatEnum _arg )

virtual

Set/Get the type of format used for reporting the time stamp of a given log message. The main options are REALVALUE and HUMANREADABLE. REALVALUE will report the time in seconds as a double number. HUMANREADABLE will report the time in formatted text such as '2007 May 7 09:23:14'

See also: SetHumanReadableFormat()

◆ Warning()

void itk::LoggerBase::Warning ( std::string const & message )

inline

Definition at line 198 of file itkLoggerBase.h.

References itk::LoggerBaseEnums::WARNING.

◆ Write()

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

virtual

Reimplemented in itk::ThreadLogger.

Member Data Documentation

◆ m_Clock

RealTimeClock::Pointer itk::LoggerBase::m_Clock {}

protected

Definition at line 245 of file itkLoggerBase.h.

◆ m_HumanReadableFormat

std::string itk::LoggerBase::m_HumanReadableFormat {}

protected

Definition at line 249 of file itkLoggerBase.h.

◆ m_LevelForFlushing

PriorityLevelEnum itk::LoggerBase::m_LevelForFlushing {}

protected

Definition at line 241 of file itkLoggerBase.h.

◆ m_Name

std::string itk::LoggerBase::m_Name {}

private

Definition at line 252 of file itkLoggerBase.h.

◆ m_Output

MultipleLogOutput::Pointer itk::LoggerBase::m_Output {}

protected

Definition at line 243 of file itkLoggerBase.h.

◆ m_PriorityLevel

PriorityLevelEnum itk::LoggerBase::m_PriorityLevel {}

protected

Definition at line 239 of file itkLoggerBase.h.

◆ m_TimeStampFormat

TimeStampFormatEnum itk::LoggerBase::m_TimeStampFormat {}

protected

Definition at line 247 of file itkLoggerBase.h.

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

itkLoggerBase.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ OutputType

◆ Pointer

◆ PriorityLevelEnum

◆ Self

◆ Superclass

◆ TimeStampFormatEnum

Constructor & Destructor Documentation

◆ LoggerBase()

◆ ~LoggerBase()

Member Function Documentation

◆ AddLogOutput()

◆ BuildFormattedEntry()

◆ Critical()

◆ Debug()

◆ Error()

◆ Fatal()

◆ Flush()

◆ GetHumanReadableFormat()

◆ GetLevelForFlushing()

◆ GetName()

◆ GetNameOfClass()

◆ GetPriorityLevel()

◆ GetTimeStampFormat()

◆ Info()

◆ PrintSelf()

◆ PrivateFlush()

◆ SetHumanReadableFormat()

◆ SetLevelForFlushing()

◆ SetName()

◆ SetPriorityLevel()

◆ SetTimeStampFormat()

◆ Warning()

◆ Write()

Member Data Documentation

◆ m_Clock

◆ m_HumanReadableFormat

◆ m_LevelForFlushing

◆ m_Name

◆ m_Output

◆ m_PriorityLevel

◆ m_TimeStampFormat