#include <itkOutputWindow.h>
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 49 of file itkOutputWindow.h.
Public Types | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = OutputWindow |
using | Superclass = Object |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = Object |
using | Superclass = LightObject |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = LightObject |
Public Member Functions | |
virtual void | DisplayDebugText (const char *file, unsigned int line, const char *className, const void *objectAddress, const char *message) |
virtual void | DisplayDebugText (const char *t) |
virtual void | DisplayErrorText (const char *file, unsigned int line, const char *className, const void *objectAddress, const char *message) |
virtual void | DisplayErrorText (const char *t) |
virtual void | DisplayGenericOutputText (const char *file, unsigned int line, const char *message) |
virtual void | DisplayGenericOutputText (const char *t) |
virtual void | DisplayText (const char *) |
virtual void | DisplayWarningText (const char *file, unsigned int line, const char *className, const void *objectAddress, const char *message) |
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 () |
![]() | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
LightObject::Pointer | CreateAnother () const override |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
virtual const TimeStamp & | GetTimeStamp () 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) const |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
![]() | |
Pointer | Clone () const |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
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 bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
OutputWindow () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~OutputWindow () override | |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
![]() | |
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 Member Functions | |
itkGetGlobalDeclarationMacro (OutputWindowGlobals, PimplGlobals) | |
Private Attributes | |
std::mutex | m_cerrMutex {} |
std::atomic< bool > | m_PromptUser {} |
Static Private Attributes | |
static OutputWindowGlobals * | m_PimplGlobals |
Additional Inherited Members | |
![]() | |
std::atomic< int > | m_ReferenceCount {} |
using itk::OutputWindow::ConstPointer = SmartPointer<const Self> |
Definition at line 58 of file itkOutputWindow.h.
using itk::OutputWindow::Pointer = SmartPointer<Self> |
Definition at line 57 of file itkOutputWindow.h.
using itk::OutputWindow::Self = OutputWindow |
Standard class type aliases.
Definition at line 55 of file itkOutputWindow.h.
using itk::OutputWindow::Superclass = Object |
Definition at line 56 of file itkOutputWindow.h.
|
protected |
Referenced by GetNameOfClass(), and SetInstance().
|
overrideprotected |
|
virtual |
Format and send debug message with context information. This allows customization of how file/line/class context is formatted.
Reimplemented in itk::LoggerOutput.
|
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 115 of file itkOutputWindow.h.
References DisplayText().
Referenced by itk::LoggerOutput::DisplayDebugText(), and itk::XMLFileOutputWindow::DisplayDebugText().
|
virtual |
Format and send warning message with context information.
Reimplemented in itk::LoggerOutput.
|
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 88 of file itkOutputWindow.h.
References DisplayText().
Referenced by itk::LoggerOutput::DisplayDebugText(), and itk::XMLFileOutputWindow::DisplayDebugText().
|
virtual |
Format and send generic output message with context information.
Reimplemented in itk::LoggerOutput.
|
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 106 of file itkOutputWindow.h.
References DisplayText().
Referenced by itk::LoggerOutput::DisplayDebugText(), and itk::XMLFileOutputWindow::DisplayDebugText().
|
virtual |
Send a string to display.
Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.
Referenced by DisplayDebugText(), DisplayErrorText(), DisplayGenericOutputText(), and DisplayWarningText().
|
virtual |
Format and send warning message with context information.
Reimplemented in itk::LoggerOutput.
|
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 97 of file itkOutputWindow.h.
References DisplayText().
Referenced by itk::LoggerOutput::DisplayDebugText(), and itk::XMLFileOutputWindow::DisplayDebugText().
|
static |
Return the singleton instance with no reference counting.
|
virtual |
Reimplemented from itk::Object.
Reimplemented in itk::FileOutputWindow, itk::LoggerOutput, itk::TextOutput, and itk::XMLFileOutputWindow.
References OutputWindow().
|
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.
|
private |
|
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.
|
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 |
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 |
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 |
Supply a user defined output window. Call ->Delete() on the supplied instance after setting it.
References OutputWindow().
Referenced by itk::LoggerOutput::OverrideITKWindow().
|
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.
|
private |
Definition at line 168 of file itkOutputWindow.h.
|
staticprivate |
Definition at line 169 of file itkOutputWindow.h.
|
private |
Definition at line 167 of file itkOutputWindow.h.