vtkInformationStringKey.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkInformationStringKey.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 vtkInformationStringKey_h
#define vtkInformationStringKey_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkInformationKey.h"

#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.

#include <string> // for std::string compat

class VTKCOMMONCORE_EXPORT vtkInformationStringKey : public vtkInformationKey
{
public:
  vtkTypeMacro(vtkInformationStringKey,vtkInformationKey);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  vtkInformationStringKey(const char* name, const char* location);
  ~vtkInformationStringKey() VTK_OVERRIDE;

  static vtkInformationStringKey* MakeKey(const char* name, const char* location)
  {
    return new vtkInformationStringKey(name, location);
  }


  void Set(vtkInformation* info, const char*);
  void Set(vtkInformation* info, const std::string &str);
  const char* Get(vtkInformation* info);

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

  void Print(ostream& os, vtkInformation* info) VTK_OVERRIDE;

private:
  vtkInformationStringKey(const vtkInformationStringKey&) VTK_DELETE_FUNCTION;
  void operator=(const vtkInformationStringKey&) VTK_DELETE_FUNCTION;
};

#endif