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::MultipleLogOutput Class Reference

#include <itkMultipleLogOutput.h>

Detailed Description

Allows writing simultaneously to multiple streams. Note that the class derives from std::streambuf and contains a std::set<> of LogOutput.

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

Definition at line 40 of file itkMultipleLogOutput.h.

+ Inheritance diagram for itk::MultipleLogOutput:
+ Collaboration diagram for itk::MultipleLogOutput:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using OutputType = LogOutput
 
using Pointer = SmartPointer< Self >
 
using Self = MultipleLogOutput
 
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

void AddLogOutput (OutputType *output)
 
void Flush () override
 
const char * GetNameOfClass () const override
 
void Write (const std::string &content) override
 
void Write (const std::string &content, double timestamp) override
 
void Write (double timestamp) override
 
virtual void Flush ()=0
 
virtual void Write (const std::string &content)=0
 
virtual void Write (const std::string &content, double timestamp)=0
 
virtual void Write (double timestamp)=0
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
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) 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::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

 MultipleLogOutput ()
 
 ~MultipleLogOutput () 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
 
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

std::set< OutputType::Pointerm_Output {}
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ConstPointer

Definition at line 48 of file itkMultipleLogOutput.h.

◆ OutputType

Definition at line 50 of file itkMultipleLogOutput.h.

◆ Pointer

Definition at line 47 of file itkMultipleLogOutput.h.

◆ Self

Definition at line 45 of file itkMultipleLogOutput.h.

◆ Superclass

Definition at line 46 of file itkMultipleLogOutput.h.

Constructor & Destructor Documentation

◆ MultipleLogOutput()

itk::MultipleLogOutput::MultipleLogOutput ( )
protected

Constructor

◆ ~MultipleLogOutput()

itk::MultipleLogOutput::~MultipleLogOutput ( )
overrideprotected

Destructor

Member Function Documentation

◆ AddLogOutput()

void itk::MultipleLogOutput::AddLogOutput ( OutputType output)

Register a additional output stream into the list of LogOutputs to write to. The messages will be sent to the streams in the same order that the streams have been added here.

◆ Flush()

void itk::MultipleLogOutput::Flush ( )
overridevirtual

Broadcast a flush operation to all the output streams

Implements itk::LogOutput.

◆ GetNameOfClass()

const char * itk::MultipleLogOutput::GetNameOfClass ( ) const
overridevirtual

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.

Reimplemented from itk::LightObject.

◆ New()

static Pointer itk::MultipleLogOutput::New ( )
static

◆ Write() [1/3]

void itk::MultipleLogOutput::Write ( const std::string &  content)
overridevirtual

Write to multiple outputs

Implements itk::LogOutput.

◆ Write() [2/3]

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

Write to a buffer

Implements itk::LogOutput.

◆ Write() [3/3]

void itk::MultipleLogOutput::Write ( double  timestamp)
overridevirtual

Write to multiple outputs

Implements itk::LogOutput.

Member Data Documentation

◆ m_Output

std::set<OutputType::Pointer> itk::MultipleLogOutput::m_Output {}
private

Definition at line 86 of file itkMultipleLogOutput.h.


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