ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::LoggerOutput Class Reference
System Objects » OS System Objects | Group Core » Module ITKCommon

#include <itkLoggerOutput.h>

Detailed Description

Used 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 50 of file itkLoggerOutput.h.

+ Inheritance diagram for itk::LoggerOutput:
+ Collaboration diagram for itk::LoggerOutput:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using LoggerType = Logger *
 
using Pointer = SmartPointer< Self >
 
using Self = LoggerOutput
 
using Superclass = OutputWindow
 
- Public Types inherited from itk::OutputWindow
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

void DisplayDebugText (const char *t) override
 
void DisplayErrorText (const char *t) override
 
void DisplayGenericOutputText (const char *t) override
 
void DisplayText (const char *t) override
 
void DisplayWarningText (const char *t) override
 
virtual LoggerType GetLogger () const
 
const char * GetNameOfClass () const override
 
virtual void OverrideITKWindow ()
 
virtual void SetLogger (LoggerType _arg)
 
- Public Member Functions inherited from itk::OutputWindow
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)
 
const char * GetNameOfClass () const override
 
virtual void SetPromptUser (bool _arg)
 
virtual bool GetPromptUser () const
 
virtual void PromptUserOn ()
 
- Public Member Functions inherited from itk::Object
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
 
const char * GetNameOfClass () const override
 
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
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::OutputWindow
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 LoggerOutput ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~LoggerOutput () override=default
 
- Protected Member Functions inherited from itk::OutputWindow
 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
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

Logger * m_Logger { nullptr }
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ConstPointer

using itk::LoggerOutput::ConstPointer = SmartPointer<const Self>

Definition at line 57 of file itkLoggerOutput.h.

◆ LoggerType

using itk::LoggerOutput::LoggerType = Logger *

Definition at line 64 of file itkLoggerOutput.h.

◆ Pointer

using itk::LoggerOutput::Pointer = SmartPointer<Self>

Definition at line 56 of file itkLoggerOutput.h.

◆ Self

using itk::LoggerOutput::Self = LoggerOutput

Standard class type aliases.

Definition at line 54 of file itkLoggerOutput.h.

◆ Superclass

using itk::LoggerOutput::Superclass = OutputWindow

Definition at line 55 of file itkLoggerOutput.h.

Constructor & Destructor Documentation

◆ LoggerOutput()

itk::LoggerOutput::LoggerOutput ( )
protecteddefault

◆ ~LoggerOutput()

itk::LoggerOutput::~LoggerOutput ( )
overrideprotecteddefault

Member Function Documentation

◆ DisplayDebugText()

void itk::LoggerOutput::DisplayDebugText ( const char *  t)
overridevirtual

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.

◆ DisplayErrorText()

void itk::LoggerOutput::DisplayErrorText ( const char *  t)
overridevirtual

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.

◆ DisplayGenericOutputText()

void itk::LoggerOutput::DisplayGenericOutputText ( const char *  t)
overridevirtual

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

Reimplemented from itk::OutputWindow.

◆ DisplayText()

void itk::LoggerOutput::DisplayText ( const char *  t)
overridevirtual

Send a string to display.

Reimplemented from itk::OutputWindow.

◆ DisplayWarningText()

void itk::LoggerOutput::DisplayWarningText ( const char *  t)
overridevirtual

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

Reimplemented from itk::OutputWindow.

◆ GetLogger()

virtual LoggerType itk::LoggerOutput::GetLogger ( ) const
virtual

◆ GetNameOfClass()

const char * itk::LoggerOutput::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ New()

static Pointer itk::LoggerOutput::New ( )
static

◆ OverrideITKWindow()

virtual void itk::LoggerOutput::OverrideITKWindow ( )
inlinevirtual

Definition at line 99 of file itkLoggerOutput.h.

References itk::OutputWindow::SetInstance().

◆ PrintSelf()

void itk::LoggerOutput::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::LightObject.

◆ SetLogger()

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

Member Data Documentation

◆ m_Logger

Logger* itk::LoggerOutput::m_Logger { nullptr }
private

Definition at line 111 of file itkLoggerOutput.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3