1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
|
/*=========================================================================
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.
=========================================================================*/
/**
* @class vtkInformationStringVectorKey
* @brief Key for String vector values.
*
* vtkInformationStringVectorKey is used to represent keys for String
* vector values in vtkInformation.h
*/
#ifndef vtkInformationStringVectorKey_h
#define vtkInformationStringVectorKey_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 vtkInformationStringVectorKey : public vtkInformationKey
{
public:
vtkTypeMacro(vtkInformationStringVectorKey,vtkInformationKey);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
vtkInformationStringVectorKey(const char* name, const char* location,
int length=-1);
~vtkInformationStringVectorKey() VTK_OVERRIDE;
/**
* This method simply returns a new vtkInformationStringVectorKey, given a
* name, a location and a required length. This method is provided for
* wrappers. Use the constructor directly from C++ instead.
*/
static vtkInformationStringVectorKey* MakeKey(const char* name, const char* location,
int length=-1)
{
return new vtkInformationStringVectorKey(name, location, length);
}
//@{
/**
* Get/Set the value associated with this key in the given
* information object.
*/
void Append(vtkInformation* info, const char* value);
void Set(vtkInformation* info, const char* value, int idx = 0);
void Append(vtkInformation* info, const std::string &value);
void Set(vtkInformation* info, const std::string &value, int idx = 0);
const char* Get(vtkInformation* info, int idx = 0);
int Length(vtkInformation* info);
//@}
/**
* Copy the entry associated with this key from one information
* object to another. If there is no entry in the first information
* object for this key, the value is removed from the second.
*/
void ShallowCopy(vtkInformation* from, vtkInformation* to) VTK_OVERRIDE;
/**
* Print the key's value in an information object to a stream.
*/
void Print(ostream& os, vtkInformation* info) VTK_OVERRIDE;
protected:
// The required length of the vector value (-1 is no restriction).
int RequiredLength;
private:
vtkInformationStringVectorKey(const vtkInformationStringVectorKey&) VTK_DELETE_FUNCTION;
void operator=(const vtkInformationStringVectorKey&) VTK_DELETE_FUNCTION;
};
#endif
|