vtkPVDataSetAttributesInformation.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkPVDataSetAttributesInformation.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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 vtkPVDataSetAttributesInformation_h
#define vtkPVDataSetAttributesInformation_h

#include "vtkDataSetAttributes.h" // needed for NUM_ATTRIBUTES
#include "vtkPVInformation.h"
#include "vtkRemotingCoreModule.h" //needed for exports

class vtkDataSetAttributes;
class vtkFieldData;
class vtkPVArrayInformation;
class vtkGenericAttributeCollection;

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


  vtkGetMacro(FieldAssociation, int);
  vtkSetMacro(FieldAssociation, int);


  void CopyFromDataSetAttributes(vtkDataSetAttributes* data);
  void DeepCopy(vtkPVDataSetAttributesInformation* info);

  void CopyFromFieldData(vtkFieldData* data);

  void CopyFromGenericAttributesOnPoints(vtkGenericAttributeCollection* data);
  void CopyFromGenericAttributesOnCells(vtkGenericAttributeCollection* data);
  void CopyFromGenericAttributes(vtkGenericAttributeCollection* data, int centering);


  void AddInformation(vtkPVDataSetAttributesInformation* info);
  void AddInformation(vtkPVInformation* info) override;

  void Initialize();


  int GetNumberOfArrays() const;
  // Because not all the arrays have to be the same length:
  int GetMaximumNumberOfTuples() const;
  vtkPVArrayInformation* GetArrayInformation(int idx) const;
  vtkPVArrayInformation* GetArrayInformation(const char* name) const;

  vtkPVArrayInformation* GetAttributeInformation(int attributeType);

  int IsArrayAnAttribute(int arrayIndex);


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

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

  // Standard cell attributes.
  int FieldAssociation;

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif