vtkInformationObjectBaseVectorKey.h

Go to the documentation of this file.

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

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

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkInformationKey.h"
#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.

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 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 n);

  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* from, vtkInformation* to) 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;
};

#endif