itk::StdStreamLogOutput Class Reference

#include <itkStdStreamLogOutput.h>

Inheritance diagram for itk::StdStreamLogOutput:

Collaboration diagram for itk::StdStreamLogOutput:

Detailed Description

Represents a standard stream output stream.

This class provides thread safety for the standard stream output stream.

Author

Hee-Su Kim, Compute Science Dept. Kyungpook National University, ISIS Center, Georgetown University.

Definition at line 42 of file itkStdStreamLogOutput.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = StdStreamLogOutput
using	StreamPointerType = std::ostream *
using	StreamType = std::ostream
using	Superclass = LogOutput
Public Types inherited from itk::LogOutput
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LogOutput
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	Flush () override
virtual const char *	GetNameOfClass () const
virtual StreamPointerType	GetStream () const
void	SetStream (StreamType &Stream)
void	Write (double timestamp) override
void	Write (std::string const &content) override
void	Write (std::string const &content, double timestamp) override
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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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::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
void	PrintSelf (std::ostream &os, Indent indent) const override
	StdStreamLogOutput ()
	~StdStreamLogOutput () override
Protected Member Functions inherited from itk::LogOutput
	LogOutput ()
	~LogOutput () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 ()

Private Attributes
std::mutex	m_Mutex
StreamPointerType	m_Stream

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

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

Definition at line 49 of file itkStdStreamLogOutput.h.

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

Definition at line 48 of file itkStdStreamLogOutput.h.

using itk::StdStreamLogOutput::Self = StdStreamLogOutput

Definition at line 46 of file itkStdStreamLogOutput.h.

using itk::StdStreamLogOutput::StreamPointerType = std::ostream *

Definition at line 53 of file itkStdStreamLogOutput.h.

using itk::StdStreamLogOutput::StreamType = std::ostream

Definition at line 51 of file itkStdStreamLogOutput.h.

using itk::StdStreamLogOutput::Superclass = LogOutput

Definition at line 47 of file itkStdStreamLogOutput.h.

Constructor & Destructor Documentation

itk::StdStreamLogOutput::StdStreamLogOutput ( )

protected

Constructor

itk::StdStreamLogOutput::~StdStreamLogOutput ( )

overrideprotected

Destructor

Member Function Documentation

virtual::itk::LightObject::Pointer itk::StdStreamLogOutput::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.

void itk::StdStreamLogOutput::Flush ( )

overridevirtual

flush a buffer

Implements itk::LogOutput.

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

virtual

Standard part of all itk objects.

Reimplemented from itk::Object.

virtual StreamPointerType itk::StdStreamLogOutput::GetStream ( ) const

virtual

static Pointer itk::StdStreamLogOutput::New ( )

static

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

void itk::StdStreamLogOutput::SetStream

(

StreamType &

Stream

)

Set a standard stream pointer

void itk::StdStreamLogOutput::Write ( double  timestamp )

overridevirtual

Write to multiple outputs

Implements itk::LogOutput.

void itk::StdStreamLogOutput::Write ( std::string const &  content )

overridevirtual

Write to a buffer

Implements itk::LogOutput.

void itk::StdStreamLogOutput::Write ( std::string const &  content, double  timestamp  )

overridevirtual

Write to a buffer

Implements itk::LogOutput.

Member Data Documentation

std::mutex itk::StdStreamLogOutput::m_Mutex

private

Definition at line 89 of file itkStdStreamLogOutput.h.

StreamPointerType itk::StdStreamLogOutput::m_Stream

private

Definition at line 87 of file itkStdStreamLogOutput.h.

---

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

• itkStdStreamLogOutput.h