Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
itk::ThreadLogger

itk::ThreadLogger Class Reference
[OS System Objects]

#include <itkThreadLogger.h>

Inheritance diagram for itk::ThreadLogger:

Inheritance graph
[legend]
Collaboration diagram for itk::ThreadLogger:

Collaboration graph
[legend]
List of all members.

Detailed Description

Class ThreadLogger is meant for providing logging service as a separate thread.

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

Definition at line 43 of file itkThreadLogger.h.

Public Types

typedef SmartPointer< const
Self > 		ConstPointer
enum  OperationType {
  SET_PRIORITY_LEVEL,
  SET_LEVEL_FOR_FLUSHING,
  ADD_LOG_OUTPUT,
  WRITE,
  FLUSH
}
typedef Logger::OutputType OutputType
typedef SmartPointer< Self > Pointer
typedef Logger::PriorityLevelType PriorityLevelType
typedef ThreadLogger Self
typedef Logger Superclass

Public Member Functions

virtual void AddLogOutput (OutputType *output)
virtual void AddLogOutput (OutputType *output)
virtual std::string BuildFormattedEntry (PriorityLevelType level, std::string const &content)
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
virtual void Flush ()
Command * GetCommand (unsigned long tag)
bool GetDebug () const
virtual PriorityLevelType GetLevelForFlushing () const
const MetaDataDictionary & GetMetaDataDictionary (void) const
MetaDataDictionary & GetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
virtual const char * GetName () const
virtual const char * GetNameOfClass () const
virtual PriorityLevelType GetPriorityLevel () const
virtual int GetReferenceCount () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
virtual void SetLevelForFlushing (PriorityLevelType level)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetName (const char *_arg)
virtual void SetPriorityLevel (PriorityLevelType level)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
virtual void Write (PriorityLevelType level, std::string const &content)
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
void Critical (std::string const &message)
void Debug (std::string const &message)
void Error (std::string const &message)
void Fatal (std::string const &message)
void Info (std::string const &message)
void Warning (std::string const &message)

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static void SetGlobalWarningDisplay (bool flag)

Protected Member Functions

bool PrintObservers (std::ostream &os, Indent indent) const
virtual void PrintSelf (std::ostream &os, Indent indent) const
 ThreadLogger ()
virtual ~ThreadLogger ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ThreadFunction (void *)

Protected Attributes

RealTimeClock::Pointer m_Clock
PriorityLevelType m_LevelForFlushing
MultipleLogOutput::Pointer m_Output
PriorityLevelType m_PriorityLevel
int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock

Member Typedef Documentation

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

Reimplemented from itk::Logger.

Definition at line 51 of file itkThreadLogger.h.

typedef Logger::OutputType itk::ThreadLogger::OutputType

Reimplemented from itk::LoggerBase.

Definition at line 57 of file itkThreadLogger.h.

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

Reimplemented from itk::Logger.

Definition at line 50 of file itkThreadLogger.h.

typedef Logger::PriorityLevelType itk::ThreadLogger::PriorityLevelType

Definition of types of messages. These codes will be used to regulate the level of detail of messages reported to the final outputs

Reimplemented from itk::LoggerBase.

Definition at line 61 of file itkThreadLogger.h.

typedef ThreadLogger itk::ThreadLogger::Self

Smart pointer typedef support.

Reimplemented from itk::Logger.

Definition at line 48 of file itkThreadLogger.h.

typedef Logger itk::ThreadLogger::Superclass

Reimplemented from itk::Logger.

Definition at line 49 of file itkThreadLogger.h.

Member Enumeration Documentation

enum itk::ThreadLogger::OperationType

Definition of types of operations for ThreadLogger.

Enumerator:
SET_PRIORITY_LEVEL 
SET_LEVEL_FOR_FLUSHING 
ADD_LOG_OUTPUT 
WRITE 
FLUSH 

Definition at line 64 of file itkThreadLogger.h.

Constructor & Destructor Documentation

itk::ThreadLogger::ThreadLogger (  )  [protected]

Constructor

virtual itk::ThreadLogger::~ThreadLogger (  )  [protected, virtual]

Destructor

Member Function Documentation

virtual void itk::LoggerBase::AddLogOutput ( OutputType *  output  )  [virtual, inherited]

Registers another output stream with the multiple output.

virtual void itk::ThreadLogger::AddLogOutput ( OutputType *  output  )  [virtual]

Registers another output stream with the multiple output.

unsigned long itk::Object::AddObserver ( const EventObject &  event,
Command *   
) const [inherited]

unsigned long itk::Object::AddObserver ( const EventObject &  event,
Command *   
) [inherited]

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError (  )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual std::string itk::LoggerBase::BuildFormattedEntry ( PriorityLevelType  level,
std::string const &  content 
) [virtual, inherited]

Provides a default formatted log entry

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]

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.

void itk::LoggerBase::Critical ( std::string const &  message  )  [inline, inherited]

Definition at line 117 of file itkLoggerBase.h.

References itk::LoggerBase::CRITICAL.

void itk::LoggerBase::Debug ( std::string const &  message  )  [inline, inherited]

Helper methods

Definition at line 105 of file itkLoggerBase.h.

References itk::LoggerBase::DEBUG.

virtual void itk::Object::DebugOff (  )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (  )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (  )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

void itk::LoggerBase::Error ( std::string const &  message  )  [inline, inherited]

Definition at line 121 of file itkLoggerBase.h.

References itk::LoggerBase::CRITICAL.

void itk::LoggerBase::Fatal ( std::string const &  message  )  [inline, inherited]

Definition at line 125 of file itkLoggerBase.h.

References itk::LoggerBase::FATAL.

virtual void itk::ThreadLogger::Flush (  )  [virtual]

Reimplemented from itk::LoggerBase.

Command* itk::Object::GetCommand ( unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (  )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (  )  [static, inherited]

virtual PriorityLevelType itk::ThreadLogger::GetLevelForFlushing (  )  const [virtual]

Reimplemented from itk::LoggerBase.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime (  )  const [virtual, inherited]

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

virtual const char* itk::LoggerBase::GetName (  )  const [virtual, inherited]

virtual const char* itk::ThreadLogger::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Logger.

virtual PriorityLevelType itk::ThreadLogger::GetPriorityLevel (  )  const [virtual]

Get the priority level for the current logger. Only messages that have priorities equal or greater than the one set here will be posted to the current outputs

Reimplemented from itk::LoggerBase.

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (  )  [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (  )  [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::LoggerBase::Info ( std::string const &  message  )  [inline, inherited]

Definition at line 109 of file itkLoggerBase.h.

References itk::LoggerBase::INFO.

void itk::Object::InvokeEvent ( const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (  )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::ThreadLogger::New (  )  [static]

New macro for creation of through a Smart Pointer

Reimplemented from itk::Logger.

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const [inherited]

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]

virtual void itk::ThreadLogger::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Print contents of a ThreadLogger

Reimplemented from itk::LoggerBase.

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

virtual void itk::Object::Register (  )  const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (  )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::Object::SetGlobalWarningDisplay ( bool  flag  )  [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::ThreadLogger::SetLevelForFlushing ( PriorityLevelType  level  )  [virtual]

Reimplemented from itk::LoggerBase.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary &  rhs  )  [inherited]

Returns:
Set the MetaDataDictionary

virtual void itk::LoggerBase::SetName ( const char *  _arg  )  [virtual, inherited]

virtual void itk::ThreadLogger::SetPriorityLevel ( PriorityLevelType  level  )  [virtual]

Set the priority level for the current logger. Only messages that have priorities equal or greater than the one set here will be posted to the current outputs

Reimplemented from itk::LoggerBase.

virtual void itk::Object::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

static ITK_THREAD_RETURN_TYPE itk::ThreadLogger::ThreadFunction ( void *   )  [static, protected]

virtual void itk::Object::UnRegister (  )  const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

void itk::LoggerBase::Warning ( std::string const &  message  )  [inline, inherited]

Definition at line 113 of file itkLoggerBase.h.

References itk::LoggerBase::WARNING.

virtual void itk::ThreadLogger::Write ( PriorityLevelType  level,
std::string const &  content 
) [virtual]

Reimplemented from itk::LoggerBase.

Member Data Documentation

RealTimeClock::Pointer itk::LoggerBase::m_Clock [protected, inherited]

Definition at line 152 of file itkLoggerBase.h.

PriorityLevelType itk::LoggerBase::m_LevelForFlushing [protected, inherited]

Definition at line 148 of file itkLoggerBase.h.

MultipleLogOutput::Pointer itk::LoggerBase::m_Output [protected, inherited]

Definition at line 150 of file itkLoggerBase.h.

PriorityLevelType itk::LoggerBase::m_PriorityLevel [protected, inherited]

Definition at line 146 of file itkLoggerBase.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

The documentation for this class was generated from the following file:
Generated at Mon Mar 12 10:26:10 2007 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000