itkObject.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkObject.h,v $
  Language:  C++
  Date:      $Date: 2009-02-06 20:53:14 $
  Version:   $Revision: 1.45 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkObject_h
#define __itkObject_h

#include "itkLightObject.h"
#include "itkEventObject.h"
#include "itkMetaDataDictionary.h"

namespace itk
{
class SubjectImplementation;
class Command;

class ITKCommon_EXPORT Object: public LightObject
{
public:
  typedef Object                    Self;
  typedef LightObject               Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  static Pointer New();

  virtual LightObject::Pointer CreateAnother() const;

  itkTypeMacro(Object, LightObject);

  virtual void DebugOn() const;

  virtual void DebugOff() const;
  
  bool GetDebug() const;
  
  void SetDebug(bool debugFlag) const;
  
  virtual unsigned long GetMTime() const;

  virtual void Modified() const;
  
  virtual void Register() const;

  virtual void UnRegister() const;

  virtual void SetReferenceCount(int);

  static void SetGlobalWarningDisplay(bool flag);
  static bool GetGlobalWarningDisplay();
  static void GlobalWarningDisplayOn()
    { Object::SetGlobalWarningDisplay(true); }
  static void GlobalWarningDisplayOff()
    { Object::SetGlobalWarningDisplay(false); }
    
  unsigned long AddObserver(const EventObject & event, Command *);
  unsigned long AddObserver(const EventObject & event, Command *) const;
 
  Command* GetCommand(unsigned long tag);

  void InvokeEvent( const EventObject & );

  void InvokeEvent( const EventObject & ) const;

  void RemoveObserver(unsigned long tag);

  void RemoveAllObservers();

  bool HasObserver( const EventObject & event ) const;

  MetaDataDictionary & GetMetaDataDictionary(void);

  const MetaDataDictionary & GetMetaDataDictionary(void) const;

  void SetMetaDataDictionary(const MetaDataDictionary & rhs);


protected:
  Object(); 
  virtual ~Object(); 

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

  bool PrintObservers(std::ostream& os, Indent indent) const;

private:
  Object(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  mutable bool m_Debug;
  
  mutable TimeStamp m_MTime;
  
  static bool m_GlobalWarningDisplay;

  SubjectImplementation* m_SubjectImplementation;
  mutable MetaDataDictionary * m_MetaDataDictionary;
};

} // end namespace itk

#endif