itk::FileOutputWindow Class Reference

#include <itkFileOutputWindow.h>

Inheritance diagram for itk::FileOutputWindow:

Collaboration diagram for itk::FileOutputWindow:

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.

Definition at line 38 of file itkFileOutputWindow.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef FileOutputWindow	Self
typedef OutputWindow	Superclass
Public Types inherited from itk::OutputWindow
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef OutputWindow	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual void	DisplayText (const char *) override
virtual const char *	GetFileName () const
virtual const char *	GetNameOfClass () const
virtual void	SetFileName (const char *_arg)
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 ()
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
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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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 ()

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

Private Member Functions
	FileOutputWindow (const Self &)
void	operator= (const Self &)

Member Typedef Documentation

typedef SmartPointer< const Self > itk::FileOutputWindow::ConstPointer

Definition at line 45 of file itkFileOutputWindow.h.

typedef SmartPointer< Self > itk::FileOutputWindow::Pointer

Definition at line 44 of file itkFileOutputWindow.h.

typedef FileOutputWindow itk::FileOutputWindow::Self

Standard class typedefs.

Definition at line 42 of file itkFileOutputWindow.h.

typedef OutputWindow itk::FileOutputWindow::Superclass

Definition at line 43 of file itkFileOutputWindow.h.

Constructor & Destructor Documentation

itk::FileOutputWindow::FileOutputWindow ( )

protected

virtual itk::FileOutputWindow::~FileOutputWindow ( )

protectedvirtual

itk::FileOutputWindow::FileOutputWindow ( const Self &  )

private

Member Function Documentation

virtual void itk::FileOutputWindow::AppendOff ( )

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.

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.

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

Reimplemented in itk::XMLFileOutputWindow.

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

overridevirtual

Send a string to display.

Reimplemented from itk::OutputWindow.

Reimplemented in itk::XMLFileOutputWindow.

virtual void itk::FileOutputWindow::FlushOff ( )

virtual

Set/Get the buffer flushing mode

virtual void itk::FileOutputWindow::FlushOn ( )

virtual

Set/Get the buffer flushing mode

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.

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

virtual

Get the filename for the log file

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

virtual

Set/Get the buffer flushing mode

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::OutputWindow.

Reimplemented in itk::XMLFileOutputWindow.

void itk::FileOutputWindow::Initialize ( )

protected

static Pointer itk::FileOutputWindow::New ( )

static

Method for creation through the object factory.

Examples:

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

void itk::FileOutputWindow::operator= ( const Self &  )

private

virtual 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::OutputWindow.

Reimplemented in itk::XMLFileOutputWindow.

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.

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

virtual

Set the filename for the log file

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

virtual

Set/Get the buffer flushing mode

Member Data Documentation

bool itk::FileOutputWindow::m_Append

protected

Definition at line 89 of file itkFileOutputWindow.h.

std::string itk::FileOutputWindow::m_FileName

protected

Definition at line 86 of file itkFileOutputWindow.h.

bool itk::FileOutputWindow::m_Flush

protected

Definition at line 88 of file itkFileOutputWindow.h.

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

protected

Definition at line 84 of file itkFileOutputWindow.h.

---

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

• itkFileOutputWindow.h