itk::OutputWindow Class Reference

Messages sent from the system are collected by this object. More...

#include <itkOutputWindow.h>

Inheritance diagram for itk::OutputWindow:

Collaboration diagram for itk::OutputWindow:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef OutputWindow	Self
typedef Object	Superclass
Public Member Functions
virtual void	DisplayDebugText (const char *t)
virtual void	DisplayErrorText (const char *t)
virtual void	DisplayGenericOutputText (const char *t)
virtual void	DisplayText (const char *)
virtual void	DisplayWarningText (const char *t)
virtual const char *	GetNameOfClass () const
Static Public Member Functions
static Pointer	GetInstance ()
static Pointer	New ()
static void	SetInstance (OutputWindow *instance)
Private Member Functions
void	operator= (const Self &)
	OutputWindow (const Self &)
Private Attributes
bool	m_PromptUser
Static Private Attributes
static Pointer	m_Instance
virtual void	SetPromptUser (bool _arg)
virtual bool	GetPromptUser () const
virtual void	PromptUserOn ()
virtual void	PromptUserOff ()
	OutputWindow ()
virtual	~OutputWindow ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

Messages sent from the system are collected by this object.

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

Definition at line 44 of file itkOutputWindow.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.

Definition at line 51 of file itkOutputWindow.h.

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

Reimplemented from itk::Object.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.

Definition at line 50 of file itkOutputWindow.h.

typedef OutputWindow itk::OutputWindow::Self

Standard class typedefs.

Reimplemented from itk::Object.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.

Definition at line 48 of file itkOutputWindow.h.

typedef Object itk::OutputWindow::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, and itk::XMLFileOutputWindow.

Definition at line 49 of file itkOutputWindow.h.

---

Constructor & Destructor Documentation

itk::OutputWindow::OutputWindow

(

)

[protected]

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

virtual itk::OutputWindow::~OutputWindow

(

)

[protected, virtual]

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

itk::OutputWindow::OutputWindow

(

const Self &

)

[private]

---

Member Function Documentation

virtual void itk::OutputWindow::DisplayDebugText

(

const char *

t

)

[inline, virtual]

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

Reimplemented in itk::LoggerOutput, and itk::XMLFileOutputWindow.

Definition at line 91 of file itkOutputWindow.h.

virtual void itk::OutputWindow::DisplayErrorText

(

const char *

t

)

[inline, virtual]

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

Reimplemented in itk::LoggerOutput, and itk::XMLFileOutputWindow.

Definition at line 76 of file itkOutputWindow.h.

virtual void itk::OutputWindow::DisplayGenericOutputText

(

const char *

t

)

[inline, virtual]

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

Reimplemented in itk::LoggerOutput, and itk::XMLFileOutputWindow.

Definition at line 86 of file itkOutputWindow.h.

virtual void itk::OutputWindow::DisplayText

(

const char *

)

[virtual]

Send a string to display.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.

virtual void itk::OutputWindow::DisplayWarningText

(

const char *

t

)

[inline, virtual]

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

Reimplemented in itk::LoggerOutput, and itk::XMLFileOutputWindow.

Definition at line 81 of file itkOutputWindow.h.

static Pointer itk::OutputWindow::GetInstance

(

)

[static]

Return the singleton instance with no reference counting.

virtual const char* itk::OutputWindow::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.

virtual bool itk::OutputWindow::GetPromptUser

(

)

const [virtual]

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

static Pointer itk::OutputWindow::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::Object.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.

void itk::OutputWindow::operator=

(

const Self &

)

[private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

Reimplemented in itk::TextOutput.

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

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

Reimplemented from itk::Object.

Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, and itk::XMLFileOutputWindow.

virtual void itk::OutputWindow::PromptUserOff

(

)

[virtual]

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

virtual void itk::OutputWindow::PromptUserOn

(

)

[virtual]

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

static void itk::OutputWindow::SetInstance

(

OutputWindow *

instance

)

[static]

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

Referenced by itk::LoggerOutput::OverrideITKWindow().

virtual void itk::OutputWindow::SetPromptUser

(

bool

_arg

)

[virtual]

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

---

Member Data Documentation

Pointer itk::OutputWindow::m_Instance [static, private]

Definition at line 110 of file itkOutputWindow.h.

bool itk::OutputWindow::m_PromptUser [private]

Definition at line 109 of file itkOutputWindow.h.

---

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

• itkOutputWindow.h