ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | Static Private Attributes | List of all members
itk::OutputWindow Class Reference

#include <itkOutputWindow.h>

+ Inheritance diagram for itk::OutputWindow:
+ Collaboration diagram for itk::OutputWindow:

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.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = OutputWindow
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

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
 
virtual void SetPromptUser (bool _arg)
 
virtual bool GetPromptUser () const
 
virtual void PromptUserOn ()
 
virtual void PromptUserOff ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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
 

Static Public Member Functions

static Pointer GetInstance ()
 
static Pointer New ()
 
static void SetInstance (OutputWindow *instance)
 
- 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 ()
 
static Pointer New ()
 

Protected Member Functions

 OutputWindow ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~OutputWindow () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~Object () override
 
- 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 ()
 

Private Attributes

bool m_PromptUser
 

Static Private Attributes

static Pointer m_Instance
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

Definition at line 53 of file itkOutputWindow.h.

Definition at line 52 of file itkOutputWindow.h.

Standard class type aliases.

Definition at line 50 of file itkOutputWindow.h.

Definition at line 51 of file itkOutputWindow.h.

Constructor & Destructor Documentation

itk::OutputWindow::OutputWindow ( )
protected
itk::OutputWindow::~OutputWindow ( )
overrideprotected

Member Function Documentation

virtual void itk::OutputWindow::DisplayDebugText ( const char *  t)
inlinevirtual

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 93 of file itkOutputWindow.h.

virtual void itk::OutputWindow::DisplayErrorText ( const char *  t)
inlinevirtual

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 78 of file itkOutputWindow.h.

virtual void itk::OutputWindow::DisplayGenericOutputText ( const char *  t)
inlinevirtual

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 88 of file itkOutputWindow.h.

virtual void itk::OutputWindow::DisplayText ( const char *  )
virtual

Send a string to display.

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

virtual void itk::OutputWindow::DisplayWarningText ( const char *  t)
inlinevirtual

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 83 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::XMLFileOutputWindow, itk::LoggerOutput, itk::FileOutputWindow, and itk::TextOutput.

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.

void itk::OutputWindow::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::Object.

Reimplemented in 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
staticprivate

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: