vtkPVArrayInformation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVArrayInformation_h
#define vtkPVArrayInformation_h

#include "vtkObject.h"
#include "vtkParaViewDeprecation.h"
#include "vtkRemotingCoreModule.h" //needed for exports
#include "vtkTuple.h"              // for vtkTuple

#include <set>    // for std::set
#include <string> // for std::string
#include <vector> // for std::vector

class vtkAbstractArray;
class vtkCellAttribute;
class vtkCellGrid;
class vtkClientServerStream;
class vtkFieldData;
class vtkGenericAttribute;

class VTKREMOTINGCORE_EXPORT vtkPVArrayInformation : public vtkObject
{
public:
  static vtkPVArrayInformation* New();
  vtkTypeMacro(vtkPVArrayInformation, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Initialize();

  vtkGetMacro(DataType, int);

  const char* GetDataTypeAsString() const { return vtkImageScalarTypeNameMacro(this->DataType); }

  std::string GetRangesAsString(int lowExponent = -6, int highExponent = 20) const;

  const char* GetName() const { return this->Name.empty() ? nullptr : this->Name.c_str(); }

  int GetNumberOfComponents() const;

  const char* GetComponentName(int component) const;

  vtkGetMacro(NumberOfTuples, vtkTypeInt64);


  const double* GetComponentRange(int comp) const VTK_SIZEHINT(2);
  void GetComponentRange(int comp, double range[2]) const;


  const double* GetComponentFiniteRange(int component) const VTK_SIZEHINT(2);
  void GetComponentFiniteRange(int comp, double range[2]) const;

  void GetDataTypeRange(double range[2]) const;


  vtkGetMacro(IsPartial, bool);


  int GetNumberOfInformationKeys() const;
  const char* GetInformationKeyLocation(int) const;
  const char* GetInformationKeyName(int) const;
  bool HasInformationKey(const char* location, const char* name) const;


  int GetNumberOfStringValues();
  const char* GetStringValue(int);


  void CopyFromArray(vtkAbstractArray* array);
  void CopyFromArray(vtkFieldData* fieldData, int fdArrayIdx);

  PARAVIEW_DEPRECATED_IN_5_14_0("Please use the CopyFromArray(vtkAbstractArray*) or "
                                "CopyFromArray(vtkFieldData*, int) overloads")
  void CopyFromArray(vtkAbstractArray* array, vtkFieldData* fieldData);

  void CopyFromCellAttribute(vtkCellGrid* grid, vtkCellAttribute* attribute);
  void CopyFromGenericAttribute(vtkGenericAttribute* array);
  void CopyToStream(vtkClientServerStream*) const;
  bool CopyFromStream(const vtkClientServerStream*);

protected:
  vtkPVArrayInformation();
  ~vtkPVArrayInformation() override;

  friend class vtkPVDataSetAttributesInformation;
  friend class vtkPVDataInformation;


  void DeepCopy(vtkPVArrayInformation* info);
  void AddInformation(vtkPVArrayInformation*, int fieldAssociation);
  vtkSetMacro(IsPartial, bool);

  vtkSetMacro(Name, std::string);

private:
  std::string Name;
  int DataType = -1;
  vtkTypeInt64 NumberOfTuples = 0;
  bool IsPartial = false;

  struct ComponentInfo
  {
    vtkTuple<double, 2> Range = vtkTuple<double, 2>({ VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX });
    vtkTuple<double, 2> FiniteRange = vtkTuple<double, 2>({ VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX });
    std::string Name;
    mutable std::string DefaultName;
  };

  std::vector<ComponentInfo> Components;
  std::vector<std::string> StringValues;

  // this array is used to store existing information keys (location/name pairs)
  std::set<std::pair<std::string, std::string>> InformationKeys;

  struct GetRangeFunctor;
  void CopyFromArrayInternal(vtkAbstractArray* array, GetRangeFunctor& getRangeFn);

  vtkPVArrayInformation(const vtkPVArrayInformation&) = delete;
  void operator=(const vtkPVArrayInformation&) = delete;
};

#endif