vtkMemoryDescriptor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkMemoryDescriptor_h
#define vtkMemoryDescriptor_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkType.h" // For vtkTypeInt64
 
VTK_ABI_NAMESPACE_BEGIN
 
class VTKCOMMONCORE_EXPORT vtkMemoryDescriptor : public vtkObject
{
public:
  static vtkMemoryDescriptor* New();
  vtkTypeMacro(vtkMemoryDescriptor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  using ReleaseFunction = void (*)(void* context);


  vtkSetMacro(Pointer, vtkTypeInt64);
  vtkGetMacro(Pointer, vtkTypeInt64);


  vtkSetMacro(SizeInBytes, vtkTypeInt64);
  vtkGetMacro(SizeInBytes, vtkTypeInt64);


  vtkSetStringMacro(MemorySpace);
  vtkGetStringMacro(MemorySpace);


  vtkSetStringMacro(Role);
  vtkGetStringMacro(Role);

  void Set(vtkTypeInt64 pointer, vtkTypeInt64 sizeInBytes, const char* memorySpace,
    const char* role = "data");


  void SetOwner(vtkObject* owner);
  vtkGetObjectMacro(Owner, vtkObject);

  void SetRelease(ReleaseFunction release, void* context);

  void SetReleaseAddress(vtkTypeInt64 release, vtkTypeInt64 context);


  ReleaseFunction GetRelease() const { return this->Release; }
  void* GetReleaseContext() const { return this->ReleaseContext; }


  vtkTypeInt64 GetReleaseAddress() const { return reinterpret_cast<vtkTypeInt64>(this->Release); }
  vtkTypeInt64 GetReleaseContextAddress() const
  {
    return reinterpret_cast<vtkTypeInt64>(this->ReleaseContext);
  }


  bool HasOwnership() const { return this->Owner != nullptr || this->Release != nullptr; }

  bool TakeRelease(ReleaseFunction& release, void*& context);
 
protected:
  vtkMemoryDescriptor();
  ~vtkMemoryDescriptor() override;
 
  vtkTypeInt64 Pointer = 0;
  vtkTypeInt64 SizeInBytes = 0;
  char* MemorySpace = nullptr;
  char* Role = nullptr;
 
  vtkObject* Owner = nullptr;
  ReleaseFunction Release = nullptr;
  void* ReleaseContext = nullptr;
 
private:
  vtkMemoryDescriptor(const vtkMemoryDescriptor&) = delete;
  void operator=(const vtkMemoryDescriptor&) = delete;

  void ClearOwnership();
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkMemoryDescriptor_h