dox/Common/Core/vtkInformationStringVectorKey.h

Go to the documentation of this file.

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

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

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

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

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

  vtkInformationStringVectorKey(const char* name, const char* location,
                                 int length=-1);
  ~vtkInformationStringVectorKey();


  void Append(vtkInformation* info, const char* value);
  void Set(vtkInformation* info, const char* value, int idx = 0);
  const char* Get(vtkInformation* info, int idx = 0);
  int Length(vtkInformation* info);

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

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

protected:
  // The required length of the vector value (-1 is no restriction).
  int RequiredLength;

private:
  vtkInformationStringVectorKey(const vtkInformationStringVectorKey&);  // Not implemented.
  void operator=(const vtkInformationStringVectorKey&);  // Not implemented.
};

#endif