vtkInformationObjectBaseKey.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 vtkInformationObjectBaseKey_h
#define vtkInformationObjectBaseKey_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkInformationKey.h"
 
#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
 
VTK_ABI_NAMESPACE_BEGIN
class vtkObjectBase;
 
class VTKCOMMONCORE_EXPORT vtkInformationObjectBaseKey : public vtkInformationKey
{
public:
  vtkTypeMacro(vtkInformationObjectBaseKey, vtkInformationKey);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkInformationObjectBaseKey(
    const char* name, const char* location, const char* requiredClass = nullptr);
  ~vtkInformationObjectBaseKey() override;

  static VTK_NEWINSTANCE vtkInformationObjectBaseKey* MakeKey(
    const char* name, const char* location, const char* requiredClass = nullptr)
  {
    return new vtkInformationObjectBaseKey(name, location, requiredClass);
  }


  void Set(vtkInformation* info, vtkObjectBase*);
  vtkObjectBase* Get(vtkInformation* info);

  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;

  void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
 
protected:
  // The type required of all objects stored with this key.
  const char* RequiredClass;
 
  vtkInformationKeySetStringMacro(RequiredClass);
 
private:
  vtkInformationObjectBaseKey(const vtkInformationObjectBaseKey&) = delete;
  void operator=(const vtkInformationObjectBaseKey&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif