itk::Logger Class Reference
[OS System Objects]

#include <itkLogger.h>

Inheritance diagram for itk::Logger:

[legend]

Collaboration diagram for itk::Logger:

[legend]

List of all members.

Detailed Description

Class Logger is meant for logging information during a run.

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

Definition at line 37 of file itkLogger.h.


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef MultipleLogOutput::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
enum	PriorityLevelType { MUSTFLUSH = 0, FATAL, CRITICAL, WARNING, INFO, DEBUG, NOTSET }
typedef Logger	Self
typedef LoggerBase	Superclass
enum	TimeStampFormatType { REALVALUE = 0, HUMANREADABLE }
Public Member Functions
virtual void	AddLogOutput (OutputType *output)
virtual std::string	BuildFormattedEntry (PriorityLevelType level, std::string const &content)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	Flush ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual PriorityLevelType	GetLevelForFlushing () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetName () const
virtual const char *	GetNameOfClass () const
virtual PriorityLevelType	GetPriorityLevel () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetLevelForFlushing (PriorityLevelType level)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetName (const char *_arg)
virtual void	SetPriorityLevel (PriorityLevelType level)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Write (PriorityLevelType level, std::string const &content)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

void	Critical (std::string const &message)
void	Debug (std::string const &message)
void	Error (std::string const &message)
void	Fatal (std::string const &message)
void	Info (std::string const &message)
void	Warning (std::string const &message)

virtual const char *	GetHumanReadableFormat () const
virtual void	SetHumanReadableFormat (const char *_arg)

virtual const TimeStampFormatType &	GetTimeStampFormat ()
virtual void	SetTimeStampFormat (TimeStampFormatType _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
	Logger ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~Logger ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
RealTimeClock::Pointer	m_Clock
std::string	m_HumanReadableFormat
PriorityLevelType	m_LevelForFlushing
MultipleLogOutput::Pointer	m_Output
PriorityLevelType	m_PriorityLevel
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
TimeStampFormatType	m_TimeStampFormat

Member Typedef Documentation

typedef SmartPointer<const Self> itk::Logger::ConstPointer

Reimplemented from itk::LoggerBase.

Reimplemented in itk::ThreadLogger.

Definition at line 43 of file itkLogger.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef MultipleLogOutput::OutputType itk::LoggerBase::OutputType [inherited]

Reimplemented in itk::ThreadLogger.

Definition at line 49 of file itkLoggerBase.h.

typedef SmartPointer<Self> itk::Logger::Pointer

Reimplemented from itk::LoggerBase.

Reimplemented in itk::ThreadLogger.

Definition at line 42 of file itkLogger.h.

typedef Logger itk::Logger::Self

Smart pointer typedef support.

Reimplemented from itk::LoggerBase.

Reimplemented in itk::ThreadLogger.

Definition at line 40 of file itkLogger.h.

typedef LoggerBase itk::Logger::Superclass

Reimplemented from itk::LoggerBase.

Reimplemented in itk::ThreadLogger.

Definition at line 41 of file itkLogger.h.

Member Enumeration Documentation

enum itk::LoggerBase::PriorityLevelType [inherited]

Definition of types of messages. These codes will be used to regulate the level of detail of messages reported to the final outputs

Enumerator:

MUSTFLUSH
FATAL
CRITICAL
WARNING
INFO
DEBUG
NOTSET

Reimplemented in itk::ThreadLogger.

Definition at line 55 of file itkLoggerBase.h.

enum itk::LoggerBase::TimeStampFormatType [inherited]

Select the type of format for reporting time stamps

Enumerator:

REALVALUE
HUMANREADABLE

Definition at line 70 of file itkLoggerBase.h.

Constructor & Destructor Documentation

itk::Logger::Logger ( ) [inline, protected]

Constructor

Definition at line 54 of file itkLogger.h.

virtual itk::Logger::~Logger ( ) [inline, protected, virtual]

Destructor

Definition at line 57 of file itkLogger.h.

Member Function Documentation

virtual void itk::LoggerBase::AddLogOutput ( OutputType * output ) [virtual, inherited]

Registers another output stream with the multiple output.

Reimplemented in itk::ThreadLogger.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual std::string itk::LoggerBase::BuildFormattedEntry	(	PriorityLevelType	level,
		std::string const &	content
	)			`[virtual, inherited]`

Provides a default formatted log entry

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

void itk::LoggerBase::Critical ( std::string const & message ) [inline, inherited]

Helper methods

Definition at line 149 of file itkLoggerBase.h.

References itk::LoggerBase::CRITICAL.

void itk::LoggerBase::Debug ( std::string const & message ) [inline, inherited]

Helper methods

Definition at line 137 of file itkLoggerBase.h.

References itk::LoggerBase::DEBUG.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

void itk::LoggerBase::Error ( std::string const & message ) [inline, inherited]

Helper methods

Definition at line 153 of file itkLoggerBase.h.

References itk::LoggerBase::CRITICAL.

void itk::LoggerBase::Fatal ( std::string const & message ) [inline, inherited]

Helper methods

Definition at line 157 of file itkLoggerBase.h.

References itk::LoggerBase::FATAL.

virtual void itk::LoggerBase::Flush ( ) [virtual, inherited]

Reimplemented in itk::ThreadLogger.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

virtual const char* itk::LoggerBase::GetHumanReadableFormat ( ) const [virtual, inherited]

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

virtual PriorityLevelType itk::LoggerBase::GetLevelForFlushing ( ) const [inline, virtual, inherited]

Reimplemented in itk::ThreadLogger.

Definition at line 126 of file itkLoggerBase.h.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

virtual const char* itk::LoggerBase::GetName ( ) const [virtual, inherited]

virtual const char* itk::Logger::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::LoggerBase.

Reimplemented in itk::ThreadLogger.

virtual PriorityLevelType itk::LoggerBase::GetPriorityLevel ( ) const [inline, virtual, inherited]

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 116 of file itkLoggerBase.h.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const TimeStampFormatType& itk::LoggerBase::GetTimeStampFormat ( ) [virtual, inherited]

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

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::LoggerBase::Info ( std::string const & message ) [inline, inherited]

Helper methods

Definition at line 141 of file itkLoggerBase.h.

References itk::LoggerBase::INFO.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::Logger::New ( ) [static]

New macro for creation of through a Smart Pointer

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

virtual void itk::LoggerBase::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Print contents of a LoggerBase

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::LoggerBase::SetHumanReadableFormat ( const char * _arg ) [virtual, inherited]

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

virtual void itk::LoggerBase::SetLevelForFlushing ( PriorityLevelType level ) [inline, virtual, inherited]

Definition at line 121 of file itkLoggerBase.h.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::LoggerBase::SetName ( const char * _arg ) [virtual, inherited]

virtual void itk::LoggerBase::SetPriorityLevel ( PriorityLevelType level ) [inline, virtual, inherited]

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

Definition at line 108 of file itkLoggerBase.h.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::LoggerBase::SetTimeStampFormat ( TimeStampFormatType _arg ) [virtual, inherited]

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'