itk::LoggerManager Class Reference
[OS System Objects]

#include <itkLoggerManager.h>

Inheritance diagram for itk::LoggerManager:

[legend]Collaboration diagram for itk::LoggerManager:

[legend]List of all members.

---

Detailed Description

Class LoggerManager is meant for centrally managing loggers.

Author:

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

LoggingObjects

Definition at line 44 of file itkLoggerManager.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Logger::Pointer	LoggerPointer
typedef std::string	NameType
typedef Logger::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Logger::PriorityLevelType	PriorityLevelType
typedef LoggerManager	Self
typedef Object	Superclass
typedef ThreadLogger::Pointer	ThreadLoggerPointer
Public Member Functions
void	AddLogger (const NameType &name, Logger *logger)
void	AddLogOutput (OutputType *output)
virtual LightObject::Pointer	CreateAnother () const
LoggerPointer	CreateLogger (const NameType &name, PriorityLevelType level, PriorityLevelType levelForFlushing=LoggerBase::MUSTFLUSH)
ThreadLoggerPointer	CreateThreadLogger (const NameType &name, PriorityLevelType level, PriorityLevelType levelForFlushing=LoggerBase::MUSTFLUSH)
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	Flush ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
Logger *	GetLogger (const NameType &name)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () 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
void	SetLevelForFlushing (PriorityLevelType level)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetPriorityLevel (PriorityLevelType level)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
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
	LoggerManager ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &s, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LoggerManager ()
Protected Attributes
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::LoggerManager::ConstPointer

Reimplemented from itk::Object. Definition at line 52 of file itkLoggerManager.h.

typedef Logger::Pointer itk::LoggerManager::LoggerPointer

Definition at line 64 of file itkLoggerManager.h.

typedef std::string itk::LoggerManager::NameType

Definition at line 67 of file itkLoggerManager.h.

typedef Logger::OutputType itk::LoggerManager::OutputType

Definition at line 62 of file itkLoggerManager.h.

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

Reimplemented from itk::Object. Definition at line 51 of file itkLoggerManager.h.

typedef Logger::PriorityLevelType itk::LoggerManager::PriorityLevelType

Definition at line 58 of file itkLoggerManager.h.

typedef LoggerManager itk::LoggerManager::Self

Smart pointer typedef support. Reimplemented from itk::Object. Definition at line 49 of file itkLoggerManager.h.

typedef Object itk::LoggerManager::Superclass

Reimplemented from itk::Object. Definition at line 50 of file itkLoggerManager.h.

typedef ThreadLogger::Pointer itk::LoggerManager::ThreadLoggerPointer

Definition at line 65 of file itkLoggerManager.h.

---

Constructor & Destructor Documentation

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

Constructor Definition at line 99 of file itkLoggerManager.h.

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

Destructor Definition at line 102 of file itkLoggerManager.h.

---

Member Function Documentation

void itk::LoggerManager::AddLogger (  const NameType &  name, Logger *  logger )

Registers a logger

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

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

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

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.

LoggerPointer itk::LoggerManager::CreateLogger (  const NameType &  name, PriorityLevelType  level, PriorityLevelType  levelForFlushing = LoggerBase::MUSTFLUSH )

create a logger and add it into LoggerManager

ThreadLoggerPointer itk::LoggerManager::CreateThreadLogger (  const NameType &  name, PriorityLevelType  level, PriorityLevelType  levelForFlushing = LoggerBase::MUSTFLUSH )

create a thread logger and add it into LoggerManager

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::LoggerManager::Flush (   )

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]

Logger* itk::LoggerManager::GetLogger (  const NameType &  name  )

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::LoggerManager::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

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::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::LoggerManager::New (   )  [static]

New macro for creation of through a Smart Pointer Reimplemented from itk::Object.

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]

void itk::LoggerManager::PrintSelf (  std::ostream &  s, Indent  indent )  const [protected, virtual]

Print contents of a LoggerManager Reimplemented from itk::Object.

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

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

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

Returns: Set the MetaDataDictionary

void itk::LoggerManager::SetPriorityLevel (  PriorityLevelType  level  )

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::LoggerManager::Write (  PriorityLevelType  level, std::string const &  content )

---

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.

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:

• itkLoggerManager.h

---