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.

LoggingObjects

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
Public Member Functions
virtual void	AddLogOutput (OutputType *output)
virtual std::string	BuildFormattedEntry (PriorityLevelType level, std::string const &content)
virtual LightObject::Pointer	CreateAnother () const
void	Critical (std::string const &message)
Helper methods *void	Debug (std::string const &message)
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	Error (std::string const &message)
void	Fatal (std::string const &message)
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	Info (std::string const &message)
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
void	Warning (std::string const &message)
virtual void	Write (PriorityLevelType level, std::string const &content)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	Logger ()
bool	PrintObservers (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	~Logger ()
Protected Attributes
RealTimeClock::Pointer	m_Clock
PriorityLevelType	m_LevelForFlushing
MultipleLogOutput::Pointer	m_Output
PriorityLevelType	m_PriorityLevel
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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 PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

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 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 Enumeration values: MUSTFLUSH  FATAL  CRITICAL  WARNING  INFO  DEBUG  NOTSET  Reimplemented in itk::ThreadLogger. Definition at line 55 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.

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]

Definition at line 107 of file itkLoggerBase.h. References itk::LoggerBase::CRITICAL.

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

Definition at line 104 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]

Definition at line 108 of file itkLoggerBase.h. References itk::LoggerBase::CRITICAL.

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

Definition at line 109 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]

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

Reimplemented in itk::ThreadLogger. Definition at line 93 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. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

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

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

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

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

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

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]

Definition at line 105 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::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), 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< typename ComponentType::HistogramType >::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.

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]

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.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

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

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

Reimplemented in itk::ThreadLogger. Definition at line 88 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 Reimplemented in itk::ThreadLogger. Definition at line 75 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::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

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

Definition at line 106 of file itkLoggerBase.h. References itk::LoggerBase::WARNING.

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

Reimplemented in itk::ThreadLogger.

---

Member Data Documentation

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 unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

RealTimeClock::Pointer itk::LoggerBase::m_Clock [protected, inherited]

Definition at line 133 of file itkLoggerBase.h.

PriorityLevelType itk::LoggerBase::m_LevelForFlushing [protected, inherited]

Definition at line 129 of file itkLoggerBase.h.

MultipleLogOutput::Pointer itk::LoggerBase::m_Output [protected, inherited]

Definition at line 131 of file itkLoggerBase.h.

PriorityLevelType itk::LoggerBase::m_PriorityLevel [protected, inherited]

Definition at line 127 of file itkLoggerBase.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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 PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkLogger.h

---