itk::LoggerOutput Class Reference
[OS System Objects]

#include <itkLoggerOutput.h>

Inheritance diagram for itk::LoggerOutput:

[legend]Collaboration diagram for itk::LoggerOutput:

[legend]List of all members.

---

Detailed Description

This class is meant for overriding itk::OutputWindow to redirect messages to itk::Logger.

Text messages that the system should display to the user are sent to this object (or subclasses of this object).

Author:

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

Definition at line 43 of file itkLoggerOutput.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Logger *	LoggerType
typedef SmartPointer< Self >	Pointer
typedef LoggerOutput	Self
typedef OutputWindow	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	DisplayDebugText (const char *t)
virtual void	DisplayErrorText (const char *t)
virtual void	DisplayGenericOutputText (const char *t)
virtual void	DisplayText (const char *t)
virtual void	DisplayWarningText (const char *t)
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual LoggerType	GetLogger ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual bool	GetPromptUser ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
virtual void	OverrideITKWindow ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PromptUserOff ()
virtual void	PromptUserOn ()
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetLogger (LoggerType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
If PromptUser is set to true then each time a line of text *is the user is asked if they want to keep getting *messages *virtual void	SetPromptUser (bool _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static Pointer	GetInstance ()
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)
static void	SetInstance (OutputWindow *instance)
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
If PromptUser is set to true then each time a line of text *is	displayed
Protected Member Functions
	LoggerOutput ()
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	~LoggerOutput ()
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::LoggerOutput::ConstPointer

Reimplemented from itk::OutputWindow. Definition at line 50 of file itkLoggerOutput.h.

typedef Logger* itk::LoggerOutput::LoggerType

Definition at line 55 of file itkLoggerOutput.h.

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

Reimplemented from itk::OutputWindow. Definition at line 49 of file itkLoggerOutput.h.

typedef LoggerOutput itk::LoggerOutput::Self

Standard class typedefs. Reimplemented from itk::OutputWindow. Definition at line 47 of file itkLoggerOutput.h.

typedef OutputWindow itk::LoggerOutput::Superclass

Reimplemented from itk::OutputWindow. Definition at line 48 of file itkLoggerOutput.h.

---

Constructor & Destructor Documentation

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

Definition at line 92 of file itkLoggerOutput.h.

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

Definition at line 93 of file itkLoggerOutput.h.

---

Member Function Documentation

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.

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.

virtual void itk::LoggerOutput::DisplayDebugText (  const char *  t  )  [virtual]

Send a string as a debug message to display. The default implementation calls DisplayText() but subclasses could present this message differently. Reimplemented from itk::OutputWindow.

virtual void itk::LoggerOutput::DisplayErrorText (  const char *  t  )  [virtual]

Send a string as an error message to display. The default implementation calls DisplayText() but subclasses could present this message differently. Reimplemented from itk::OutputWindow.

virtual void itk::LoggerOutput::DisplayGenericOutputText (  const char *  t  )  [virtual]

Send a string as a message to display. The default implementation calls DisplayText() but subclasses could present this message differently. Reimplemented from itk::OutputWindow.

virtual void itk::LoggerOutput::DisplayText (  const char *  t  )  [virtual]

Send a string to display. Reimplemented from itk::OutputWindow.

virtual void itk::LoggerOutput::DisplayWarningText (  const char *  t  )  [virtual]

Send a string as a warningmessage to display. The default implementation calls DisplayText() but subclasses could present this message differently. Reimplemented from itk::OutputWindow.

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]

static Pointer itk::OutputWindow::GetInstance (   )  [static, inherited]

Return the singleton instance with no reference counting.

virtual LoggerType itk::LoggerOutput::GetLogger (   )  [virtual]

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

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

virtual bool itk::OutputWindow::GetPromptUser (   )  [virtual, inherited]

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

This is a singleton pattern New. There will only be ONE reference to a OutputWindow object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits. Reimplemented from itk::OutputWindow.

virtual void itk::LoggerOutput::OverrideITKWindow (   )  [inline, virtual]

Definition at line 86 of file itkLoggerOutput.h. References itk::OutputWindow::SetInstance().

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::LoggerOutput::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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. Reimplemented from itk::OutputWindow.

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

virtual void itk::OutputWindow::PromptUserOff (   )  [virtual, inherited]

virtual void itk::OutputWindow::PromptUserOn (   )  [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().

static void itk::OutputWindow::SetInstance (  OutputWindow *  instance  )  [static, inherited]

Supply a user defined output window. Call ->Delete() on the supplied instance after setting it. Referenced by OverrideITKWindow().

virtual void itk::LoggerOutput::SetLogger (  LoggerType  _arg  )  [virtual]

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

Returns: Set the MetaDataDictionary

If PromptUser is set to true then each time a line of text* is the user is asked if they want to keep getting* messages* virtual void itk::OutputWindow::SetPromptUser (  bool  _arg  )  [virtual, inherited]

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.

---

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.

If PromptUser is set to true then each time a line of text* is itk::OutputWindow::displayed [inherited]

Definition at line 82 of file itkOutputWindow.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:

• itkLoggerOutput.h

---