vtkPVDataSetAttributesInformation.h

Go to the documentation of this file.

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

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

#include <memory> // For std::unique_ptr
#include <string> // For std::string

class vtkClientServerStream;
class vtkDataObject;
class vtkPVArrayInformation;

class VTKREMOTINGCORE_EXPORT vtkPVDataSetAttributesInformation : public vtkObject
{
public:
  class VTKREMOTINGCORE_EXPORT AlphabeticalArrayInformationIterator
  {
  public:
    AlphabeticalArrayInformationIterator(vtkPVDataSetAttributesInformation* source);
    ~AlphabeticalArrayInformationIterator();

    void GoToFirstItem();
    void GoToNextItem();
    bool IsDoneWithTraversal() const;
    vtkPVArrayInformation* GetCurrentArrayInformation();

  private:
    struct vtkInternals;
    std::unique_ptr<vtkInternals> Internals;
  };

  static vtkPVDataSetAttributesInformation* New();
  vtkTypeMacro(vtkPVDataSetAttributesInformation, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkGetMacro(FieldAssociation, int);
  vtkGetStringMacro(FieldName);

  void Initialize();

  int GetNumberOfArrays() const;

  int GetMaximumNumberOfTuples() const;


  vtkPVArrayInformation* GetArrayInformation(int idx) const;
  vtkPVArrayInformation* GetArrayInformation(const char* name) const;

  vtkPVArrayInformation* GetAttributeInformation(int attributeType);

  int IsArrayAnAttribute(int arrayIndex);

  AlphabeticalArrayInformationIterator* NewAlphabeticalArrayInformationIterator();

protected:
  vtkPVDataSetAttributesInformation();
  ~vtkPVDataSetAttributesInformation() override;

  friend class vtkPVDataInformation;
  friend class vtkPVDataInformationAccumulator;


  vtkSetMacro(FieldAssociation, int);
  vtkSetStringMacro(FieldName);


  void CopyToStream(vtkClientServerStream*);
  void CopyFromStream(const vtkClientServerStream*);

  void AddInformation(vtkPVDataSetAttributesInformation*);

  void DeepCopy(vtkPVDataSetAttributesInformation*);

  void CopyFromDataObject(vtkDataObject* dobj);

  void MarkArraysAsGlobal();

private:
  vtkPVDataSetAttributesInformation(const vtkPVDataSetAttributesInformation&) = delete;
  void operator=(const vtkPVDataSetAttributesInformation&) = delete;

  int FieldAssociation;
  char* FieldName;

  class vtkInternals;
  vtkInternals* Internals;
};

#endif