itkLightObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkLightObject_h
#define itkLightObject_h
 
#include "itkMacro.h"
#include "itkSmartPointer.h"
#include "itkTimeStamp.h"
#include "itkIndent.h"
#include <atomic>
 
#include <iostream>
#include <typeinfo>
 
#if defined(_WIN32)
#  include "itkWindows.h"
#endif
 
namespace itk
{
class ITKCommon_EXPORT LightObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LightObject);

  using Self = LightObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  static Pointer
  New();

  virtual Pointer
  CreateAnother() const;

  Pointer
  Clone() const
  {
    return this->InternalClone();
  }

  virtual void
  Delete();

  itkVirtualGetNameOfClassMacro(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 noexcept;

  virtual int
  GetReferenceCount() const
  {
    return m_ReferenceCount;
  }

  virtual void
  SetReferenceCount(int);
 
protected:
  LightObject();
  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;

  virtual LightObject::Pointer
  InternalClone() const;

  mutable std::atomic<int> m_ReferenceCount{};
};

ITKCommon_EXPORT std::ostream &
                 operator<<(std::ostream & os, const LightObject & o);
 
} // end namespace itk
 
#endif