#include <itkFileOutputWindow.h>

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:

All ITK Sphinx Examples

Direct Warning To File

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

Definition at line 42 of file 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
void	DisplayText (const char *) override

virtual const char *	GetFileName () const

const char *	GetNameOfClass () const override

virtual void	SetFileName (const char *_arg)


virtual void	SetFlush (bool _arg)

virtual bool	GetFlush () const

virtual void	FlushOn ()


virtual void	SetAppend (bool _arg)

virtual bool	GetAppend () const

virtual void	AppendOn ()

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)

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

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 void	Delete ()

virtual int	GetReferenceCount () const

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	FileOutputWindow ()

void	Initialize ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~FileOutputWindow () override

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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
bool	m_Append {}

std::string	m_FileName {}

bool	m_Flush {}

std::ofstream *	m_Stream {}

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 51 of file itkFileOutputWindow.h.

◆ Pointer

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

Definition at line 50 of file itkFileOutputWindow.h.

◆ Self

using itk::FileOutputWindow::Self = FileOutputWindow

Standard class type aliases.

Definition at line 48 of file itkFileOutputWindow.h.

◆ Superclass

using itk::FileOutputWindow::Superclass = OutputWindow

Definition at line 49 of file itkFileOutputWindow.h.

Constructor & Destructor Documentation

◆ FileOutputWindow()

itk::FileOutputWindow::FileOutputWindow ( )

protected

◆ ~FileOutputWindow()

itk::FileOutputWindow::~FileOutputWindow ( )

overrideprotected

Member Function Documentation

◆ AppendOn()

virtual void itk::FileOutputWindow::AppendOn ( )

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.

◆ DisplayText()

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

overridevirtual

Send a string to display.

Reimplemented from itk::OutputWindow.

Reimplemented in itk::XMLFileOutputWindow.

◆ FlushOn()

virtual void itk::FileOutputWindow::FlushOn ( )

virtual

Set/Get the buffer flushing mode

◆ GetAppend()

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

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.

◆ 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()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Reimplemented in itk::XMLFileOutputWindow.

◆ Initialize()

void itk::FileOutputWindow::Initialize ( )

protected

◆ New()

static Pointer itk::FileOutputWindow::New ( )

static

Method for creation through the object factory.

Examples: Examples/RegistrationITKv4/ImageRegistration10.cxx, and Examples/RegistrationITKv4/ImageRegistration19.cxx.

◆ PrintSelf()

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

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

Definition at line 98 of file itkFileOutputWindow.h.

◆ m_FileName

std::string itk::FileOutputWindow::m_FileName {}

protected

Definition at line 95 of file itkFileOutputWindow.h.

◆ m_Flush

bool itk::FileOutputWindow::m_Flush {}

protected

Definition at line 97 of file itkFileOutputWindow.h.

◆ m_Stream

std::ofstream* itk::FileOutputWindow::m_Stream {}

protected

Definition at line 93 of file itkFileOutputWindow.h.

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

itkFileOutputWindow.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ FileOutputWindow()

◆ ~FileOutputWindow()

Member Function Documentation

◆ AppendOn()

◆ DisplayText()

◆ FlushOn()

◆ GetAppend()

◆ GetFileName()

◆ GetFlush()

◆ GetNameOfClass()

◆ Initialize()

◆ New()

◆ PrintSelf()

◆ SetAppend()

◆ SetFileName()

◆ SetFlush()

Member Data Documentation

◆ m_Append

◆ m_FileName

◆ m_Flush

◆ m_Stream