vtkInformationObjectBaseKey.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkInformationObjectBaseKey.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 vtkInformationObjectBaseKey_h
#define vtkInformationObjectBaseKey_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkInformationKey.h"
 
#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
 
class vtkObjectBase;
 
class VTKCOMMONCORE_EXPORT vtkInformationObjectBaseKey : public vtkInformationKey
{
public:
  vtkTypeMacro(vtkInformationObjectBaseKey,vtkInformationKey);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  vtkInformationObjectBaseKey(const char* name, const char* location,
                              const char* requiredClass=0);
  ~vtkInformationObjectBaseKey();
 
 
  static vtkInformationObjectBaseKey* MakeKey(const char* name, const char* location,
                                             const char* requiredClass=0)
    {
    return new vtkInformationObjectBaseKey(name, location, requiredClass);
    }
 
 
  void Set(vtkInformation* info, vtkObjectBase*);
  vtkObjectBase* Get(vtkInformation* info);
 
  virtual void ShallowCopy(vtkInformation* from, vtkInformation* to);
 
  virtual void Report(vtkInformation* info, vtkGarbageCollector* collector);
 
protected:
  // The type required of all objects stored with this key.
  const char* RequiredClass;
 
  vtkInformationKeySetStringMacro(RequiredClass);
 
private:
  vtkInformationObjectBaseKey(const vtkInformationObjectBaseKey&);  // Not implemented.
  void operator=(const vtkInformationObjectBaseKey&);  // Not implemented.
};
 
#endif