vtkObjectBase.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkObjectBase.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/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 notice for more information.
 
=========================================================================*/
#ifndef vtkObjectBase_h
#define vtkObjectBase_h
 
// Semantics around vtkDebugLeaks usage has changed. Now just call
// vtkObjectBase::InitializeObjectBase() after creating an object with New().
// The object factory methods take care of this automatically.
#define VTK_HAS_INITIALIZE_OBJECT_BASE
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkIndent.h"
#include "vtkSystemIncludes.h"
#include "vtkType.h"
 
#include <atomic> // For std::atomic
 
class vtkGarbageCollector;
class vtkGarbageCollectorToObjectBaseFriendship;
class vtkWeakPointerBase;
class vtkWeakPointerBaseToObjectBaseFriendship;
 
class VTKCOMMONCORE_EXPORT vtkObjectBase
{
  virtual const char* GetClassNameInternal() const { return "vtkObjectBase"; }
 
public:
#ifdef VTK_WORKAROUND_WINDOWS_MANGLE
// Avoid windows name mangling.
#define GetClassNameA GetClassName
#define GetClassNameW GetClassName
#endif
 
  const char* GetClassName() const;
 
#ifdef VTK_WORKAROUND_WINDOWS_MANGLE
#undef GetClassNameW
#undef GetClassNameA
 
  // Define possible mangled names.
  const char* GetClassNameA() const;
  const char* GetClassNameW() const;
 
#endif
 
  static vtkTypeBool IsTypeOf(const char* name);
 
  virtual vtkTypeBool IsA(const char* name);
 
  static vtkIdType GetNumberOfGenerationsFromBaseType(const char* name);
 
  virtual vtkIdType GetNumberOfGenerationsFromBase(const char* name);
 
  virtual void Delete();
 
  virtual void FastDelete();
 
  static vtkObjectBase* New()
  {
    vtkObjectBase* o = new vtkObjectBase;
    o->InitializeObjectBase();
    return o;
  }
 
  // Called by implementations of vtkObject::New(). Centralized location for
  // vtkDebugLeaks registration:
  void InitializeObjectBase();
 
#ifdef _WIN32
  // avoid dll boundary problems
  void* operator new(size_t tSize);
  void operator delete(void* p);
#endif
 
  void Print(ostream& os);
 
 
  virtual void PrintSelf(ostream& os, vtkIndent indent);
  virtual void PrintHeader(ostream& os, vtkIndent indent);
  virtual void PrintTrailer(ostream& os, vtkIndent indent);
 
  virtual void Register(vtkObjectBase* o);
 
  virtual void UnRegister(vtkObjectBase* o);
 
  int GetReferenceCount() { return this->ReferenceCount; }
 
  void SetReferenceCount(int);
 
#ifndef VTK_LEGACY_REMOVE
  void PrintRevisions(ostream&) {}
#endif
 
protected:
  vtkObjectBase();
  virtual ~vtkObjectBase();
 
#ifndef VTK_LEGACY_REMOVE
  virtual void CollectRevisions(ostream&) {} // Legacy; do not use!
#endif
 
  std::atomic<int32_t> ReferenceCount;
  vtkWeakPointerBase** WeakPointers;
 
  // Internal Register/UnRegister implementation that accounts for
  // possible garbage collection participation.  The second argument
  // indicates whether to participate in garbage collection.
  virtual void RegisterInternal(vtkObjectBase*, vtkTypeBool check);
  virtual void UnRegisterInternal(vtkObjectBase*, vtkTypeBool check);
 
  // See vtkGarbageCollector.h:
  virtual void ReportReferences(vtkGarbageCollector*);
 
private:
  friend VTKCOMMONCORE_EXPORT ostream& operator<<(ostream& os, vtkObjectBase& o);
  friend class vtkGarbageCollectorToObjectBaseFriendship;
  friend class vtkWeakPointerBaseToObjectBaseFriendship;
 
protected:
  vtkObjectBase(const vtkObjectBase&) {}
  void operator=(const vtkObjectBase&) {}
};
 
#endif
 
// VTK-HeaderTest-Exclude: vtkObjectBase.h