ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::FileOutputWindow Class Reference

#include <itkFileOutputWindow.h>

+ Inheritance diagram for itk::FileOutputWindow:
+ Collaboration diagram for itk::FileOutputWindow:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = FileOutputWindow
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void DisplayText (const char *) override
 
virtual const char * GetFileName () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetFileName (const char *_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 DisplayWarningText (const char *t)
 
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
 
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
 
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 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
std::ofstream * m_Stream
 
std::string m_FileName
 
bool m_Flush
 
bool m_Append
 
virtual void SetFlush (bool _arg)
 
virtual bool GetFlush () const
 
virtual void FlushOn ()
 
virtual void FlushOff ()
 
virtual void SetAppend (bool _arg)
 
virtual bool GetAppend () const
 
virtual void AppendOn ()
 
virtual void AppendOff ()
 
 FileOutputWindow ()
 
 ~FileOutputWindow () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void Initialize ()
 

Additional Inherited Members

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

Detailed Description

Messages sent from the system are sent to a file.

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

ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/Common/DirectWarningToFile/Code.cxx.

Definition at line 42 of file itkFileOutputWindow.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 51 of file itkFileOutputWindow.h.

◆ Pointer

Definition at line 50 of file itkFileOutputWindow.h.

◆ Self

Standard class type aliases.

Definition at line 48 of file itkFileOutputWindow.h.

◆ Superclass

Definition at line 49 of file itkFileOutputWindow.h.

Constructor & Destructor Documentation

◆ FileOutputWindow()

itk::FileOutputWindow::FileOutputWindow ( )
protected

Set/Get the buffer flushing mode

◆ ~FileOutputWindow()

itk::FileOutputWindow::~FileOutputWindow ( )
overrideprotected

Set/Get the buffer flushing mode

Member Function Documentation

◆ AppendOff()

virtual void itk::FileOutputWindow::AppendOff ( )
virtual

Set/Get the buffer flushing mode

◆ AppendOn()

virtual void itk::FileOutputWindow::AppendOn ( )
virtual

Set/Get the buffer flushing mode

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::FileOutputWindow::CreateAnother ( ) const
virtual

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.

Reimplemented in itk::XMLFileOutputWindow.

◆ DisplayText()

void itk::FileOutputWindow::DisplayText ( const char *  )
overridevirtual

Send a string to display.

Reimplemented from itk::OutputWindow.

Reimplemented in itk::XMLFileOutputWindow.

◆ FlushOff()

virtual void itk::FileOutputWindow::FlushOff ( )
virtual

Set/Get the buffer flushing mode

◆ FlushOn()

virtual void itk::FileOutputWindow::FlushOn ( )
virtual

Set/Get the buffer flushing mode

◆ GetAppend()

virtual bool itk::FileOutputWindow::GetAppend ( ) const
virtual

Set/Get the buffer flushing mode

◆ GetFileName()

virtual const char* itk::FileOutputWindow::GetFileName ( ) const
virtual

Get the filename for the log file

◆ GetFlush()

virtual bool itk::FileOutputWindow::GetFlush ( ) const
virtual

Set/Get the buffer flushing mode

◆ GetNameOfClass()

virtual const char* itk::FileOutputWindow::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::OutputWindow.

Reimplemented in itk::XMLFileOutputWindow.

◆ Initialize()

void itk::FileOutputWindow::Initialize ( )
protected

Set/Get the buffer flushing mode

◆ New()

static Pointer itk::FileOutputWindow::New ( )
static

◆ PrintSelf()

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

Set/Get the buffer flushing mode

Reimplemented from itk::LightObject.

Reimplemented in itk::XMLFileOutputWindow.

◆ SetAppend()

virtual void itk::FileOutputWindow::SetAppend ( bool  _arg)
virtual

Setting append will cause the log file to be opened in append mode. Otherwise, if the log file exists, it will be overwritten each time the FileOutputWindow is created.

◆ SetFileName()

virtual void itk::FileOutputWindow::SetFileName ( const char *  _arg)
virtual

Set the filename for the log file

◆ SetFlush()

virtual void itk::FileOutputWindow::SetFlush ( bool  _arg)
virtual

Set/Get the buffer flushing mode

Member Data Documentation

◆ m_Append

bool itk::FileOutputWindow::m_Append
protected

Set/Get the buffer flushing mode

Definition at line 98 of file itkFileOutputWindow.h.

◆ m_FileName

std::string itk::FileOutputWindow::m_FileName
protected

Set/Get the buffer flushing mode

Definition at line 95 of file itkFileOutputWindow.h.

◆ m_Flush

bool itk::FileOutputWindow::m_Flush
protected

Set/Get the buffer flushing mode

Definition at line 97 of file itkFileOutputWindow.h.

◆ m_Stream

std::ofstream* itk::FileOutputWindow::m_Stream
protected

Set/Get the buffer flushing mode

Definition at line 93 of file itkFileOutputWindow.h.


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