vtkInformationObjectBaseVectorKey.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 vtkInformationObjectBaseVectorKey_h
#define vtkInformationObjectBaseVectorKey_h
 
#include "vtkCommonCoreModule.h"            // For export macro
#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
#include "vtkInformationKey.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkInformationObjectBaseVectorValue;
 
class VTKCOMMONCORE_EXPORT vtkInformationObjectBaseVectorKey : public vtkInformationKey
{
public:
  vtkTypeMacro(vtkInformationObjectBaseVectorKey, vtkInformationKey);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkInformationObjectBaseVectorKey(
    const char* name, const char* location, const char* requiredClass = nullptr);
  //
  ~vtkInformationObjectBaseVectorKey() override;
 
  static VTK_NEWINSTANCE vtkInformationObjectBaseVectorKey* MakeKey(
    const char* name, const char* location, const char* requiredClass = nullptr)
  {
    return new vtkInformationObjectBaseVectorKey(name, location, requiredClass);
  }
 
  void Clear(vtkInformation* info);
 
  void Resize(vtkInformation* info, int size);
 
  int Size(vtkInformation* info);
  int Length(vtkInformation* info) { return this->Size(info); }
 
  void Append(vtkInformation* info, vtkObjectBase* value);
 
  void Set(vtkInformation* info, vtkObjectBase* value, int i);
 
 
  void Remove(vtkInformation* info, vtkObjectBase* val);
  void Remove(vtkInformation* info, int idx);
  using Superclass::Remove; // Don't hide base class methods
 
  void SetRange(vtkInformation* info, vtkObjectBase** source, int from, int to, int n);
 
  void GetRange(vtkInformation* info, vtkObjectBase** dest, int from, int to, int n);
 
  vtkObjectBase* Get(vtkInformation* info, int idx);
 
  // _escription:
  // Get a pointer to the first vtkObjectBase in the vector. We are
  // uysing a vector of smart pointers so this is not easy to
  // implement.
  // vtkObjectBase **Get(vtkInformation* info);
 
  void ShallowCopy(vtkInformation* source, vtkInformation* dest) override;
 
  void Print(ostream& os, vtkInformation* info) override;
 
protected:
  // The type required of all objects stored with this key.
  const char* RequiredClass;
 
private:
  void CreateObjectBase();
  bool ValidateDerivedType(vtkInformation* info, vtkObjectBase* aValue);
  vtkInformationObjectBaseVectorValue* GetObjectBaseVector(vtkInformation* info);
 
  //
  vtkInformationObjectBaseVectorKey(const vtkInformationObjectBaseVectorKey&) = delete;
  void operator=(const vtkInformationObjectBaseVectorKey&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif