itkLightObject.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLightObject.h,v $
  Language:  C++
  Date:      $Date: 2009-02-05 19:05:00 $
  Version:   $Revision: 1.42 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.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 __itkLightObject_h
#define __itkLightObject_h

#include "itkSmartPointer.h"
#include "itkTimeStamp.h"
#include "itkIndent.h"
#include "itkSimpleFastMutexLock.h"
#include "itkMacro.h"

#include <iostream>
#include <typeinfo>

#if defined(_WIN32)
// To get LONG defined
  #include "itkWindows.h"
#elif defined(__APPLE__)
// To get MAC_OS_X_VERSION_MIN_REQUIRED defined
  #include <AvailabilityMacros.h>
#endif

namespace itk
{
  
class ITKCommon_EXPORT LightObject 
{
public:
  typedef LightObject               Self;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  
  static Pointer New();

  virtual Pointer CreateAnother() const;

  virtual void Delete();

  virtual const char *GetNameOfClass() const 
    {return "LightObject";}

#ifdef _WIN32

  void* operator new(size_t);
  void* operator new[](size_t);
  void operator delete(void*);
  void operator delete[](void*, size_t);
#endif 
  
  void Print(std::ostream& os, Indent indent=0) const;

  static void BreakOnError();
  
  virtual void Register() const;

  virtual void UnRegister() const;

  virtual int GetReferenceCount() const 
    {return static_cast<int>(m_ReferenceCount);}

  virtual void SetReferenceCount(int);

protected:
  LightObject():m_ReferenceCount(1) {}
  virtual ~LightObject(); 

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

#if (defined(WIN32) || defined(_WIN32))
  typedef LONG InternalReferenceCountType;
#elif defined(__APPLE__) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1050)
 #if defined (__LP64__) && __LP64__
  typedef volatile int64_t InternalReferenceCountType;
 #else
  typedef volatile int32_t InternalReferenceCountType;
 #endif
#elif defined(__GLIBCPP__) || defined(__GLIBCXX__)
  typedef _Atomic_word InternalReferenceCountType;
#else
  typedef int InternalReferenceCountType;
#endif
  
  mutable InternalReferenceCountType m_ReferenceCount;

  mutable SimpleFastMutexLock m_ReferenceCountLock;

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

} // end namespace itk
  
#endif