ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
itk::LoggerBase Class Reference
OS System Objects | Module ITKCommon

#include <itkLoggerBase.h>

+ Inheritance diagram for itk::LoggerBase:
+ Collaboration diagram for itk::LoggerBase:

List of all members.

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 LoggerBase Self
typedef Object Superclass
enum  TimeStampFormatType {
  REALVALUE = 0,
  HUMANREADABLE
}
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual void AddLogOutput (OutputType *output)
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 void Flush ()
virtual PriorityLevelType GetLevelForFlushing () const
virtual const char * GetName () const
virtual const char * GetNameOfClass () const
virtual PriorityLevelType GetPriorityLevel () const
void Info (std::string const &message)
virtual void SetLevelForFlushing (PriorityLevelType level)
virtual void SetName (const char *_arg)
virtual void SetPriorityLevel (PriorityLevelType level)
void Warning (std::string const &message)
virtual void Write (PriorityLevelType level, std::string const &content)
virtual void SetTimeStampFormat (TimeStampFormatType _arg)
virtual const TimeStampFormatType & GetTimeStampFormat ()
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 LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long 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
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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

Protected Member Functions

 LoggerBase ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual ~LoggerBase ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- 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
PriorityLevelType m_LevelForFlushing
MultipleLogOutput::Pointer m_Output
PriorityLevelType m_PriorityLevel
TimeStampFormatType m_TimeStampFormat

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 flag)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()

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

Member Typedef Documentation

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

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger, and itk::Logger.

Definition at line 44 of file itkLoggerBase.h.

typedef MultipleLogOutput::OutputType itk::LoggerBase::OutputType

Reimplemented in itk::ThreadLogger.

Definition at line 47 of file itkLoggerBase.h.

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

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger, and itk::Logger.

Definition at line 43 of file itkLoggerBase.h.

typedef LoggerBase itk::LoggerBase::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger, and itk::Logger.

Definition at line 41 of file itkLoggerBase.h.

typedef Object itk::LoggerBase::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger, and itk::Logger.

Definition at line 42 of file itkLoggerBase.h.

Member Enumeration Documentation

enum itk::LoggerBase::PriorityLevelType

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

enum itk::LoggerBase::TimeStampFormatType

Select the type of format for reporting time stamps

Enumerator:
REALVALUE 
HUMANREADABLE 

Definition at line 67 of file itkLoggerBase.h.

Constructor & Destructor Documentation

itk::LoggerBase::LoggerBase ( )
protected

Constructor

virtual itk::LoggerBase::~LoggerBase ( )
protectedvirtual

Destructor

Member Function Documentation

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

Registers another output stream with the multiple output.

Reimplemented in itk::ThreadLogger.

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

Provides a default formatted log entry

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

Definition at line 148 of file itkLoggerBase.h.

References CRITICAL.

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

Helper methods

Definition at line 133 of file itkLoggerBase.h.

References DEBUG.

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

Definition at line 153 of file itkLoggerBase.h.

References CRITICAL.

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

Definition at line 158 of file itkLoggerBase.h.

References FATAL.

virtual void itk::LoggerBase::Flush ( )
virtual

Reimplemented in itk::ThreadLogger.

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
virtual PriorityLevelType itk::LoggerBase::GetLevelForFlushing ( ) const
inlinevirtual

Reimplemented in itk::ThreadLogger.

Definition at line 122 of file itkLoggerBase.h.

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger, and itk::Logger.

virtual PriorityLevelType 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 112 of file itkLoggerBase.h.

virtual const TimeStampFormatType& itk::LoggerBase::GetTimeStampFormat ( )
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()
void itk::LoggerBase::Info ( std::string const &  message)
inline

Definition at line 138 of file itkLoggerBase.h.

References INFO.

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

Print contents of a LoggerBase

Reimplemented from itk::Object.

Reimplemented in itk::ThreadLogger.

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
virtual void itk::LoggerBase::SetLevelForFlushing ( PriorityLevelType  level)
inlinevirtual

Reimplemented in itk::ThreadLogger.

Definition at line 117 of file itkLoggerBase.h.

virtual void itk::LoggerBase::SetName ( const char *  _arg)
virtual
virtual void itk::LoggerBase::SetPriorityLevel ( PriorityLevelType  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 104 of file itkLoggerBase.h.

virtual void itk::LoggerBase::SetTimeStampFormat ( TimeStampFormatType  _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()
void itk::LoggerBase::Warning ( std::string const &  message)
inline

Definition at line 143 of file itkLoggerBase.h.

References WARNING.

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

Reimplemented in itk::ThreadLogger.

Member Data Documentation

RealTimeClock::Pointer itk::LoggerBase::m_Clock
protected

Definition at line 184 of file itkLoggerBase.h.

std::string itk::LoggerBase::m_HumanReadableFormat
protected

Definition at line 188 of file itkLoggerBase.h.

PriorityLevelType itk::LoggerBase::m_LevelForFlushing
protected

Definition at line 180 of file itkLoggerBase.h.

std::string itk::LoggerBase::m_Name
private

Definition at line 191 of file itkLoggerBase.h.

MultipleLogOutput::Pointer itk::LoggerBase::m_Output
protected

Definition at line 182 of file itkLoggerBase.h.

PriorityLevelType itk::LoggerBase::m_PriorityLevel
protected

Definition at line 178 of file itkLoggerBase.h.

TimeStampFormatType itk::LoggerBase::m_TimeStampFormat
protected

Definition at line 186 of file itkLoggerBase.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Wed Jul 11 2012 00:14:51 for ITK by doxygen 1.8.1