vtkPVDataInformation.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkPVDataInformation.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 vtkPVDataInformation_h
#define vtkPVDataInformation_h

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

class vtkCollection;
class vtkCompositeDataSet;
class vtkDataObject;
class vtkDataSet;
class vtkGenericDataSet;
class vtkGraph;
class vtkHyperTreeGrid;
class vtkInformation;
class vtkPVArrayInformation;
class vtkPVCompositeDataInformation;
class vtkPVDataSetAttributesInformation;
class vtkPVDataInformationHelper;
class vtkSelection;
class vtkTable;

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

  vtkPVArrayInformation* GetArrayInformation(const char* arrayname, int fieldAssociation);


  vtkSetMacro(PortNumber, int);
  vtkGetMacro(PortNumber, int);

  void CopyFromObject(vtkObject*) override;

  void AddInformation(vtkPVInformation* info) override;

  virtual void AddInformation(vtkPVInformation*, int addingParts);


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


  void CopyParametersToStream(vtkMultiProcessStream&) override;
  void CopyParametersFromStream(vtkMultiProcessStream&) override;

  void Initialize();


  vtkGetMacro(DataSetType, int);
  vtkGetMacro(CompositeDataSetType, int);
  const char* GetDataSetTypeAsString();
  bool DataSetTypeIsA(const char* type);
  vtkGetMacro(NumberOfPoints, vtkTypeInt64);
  vtkGetMacro(NumberOfCells, vtkTypeInt64);
  vtkGetMacro(NumberOfRows, vtkTypeInt64);
  vtkGetMacro(NumberOfTrees, vtkTypeInt64);
  vtkGetMacro(NumberOfVertices, vtkTypeInt64);
  vtkGetMacro(NumberOfEdges, vtkTypeInt64);
  vtkGetMacro(NumberOfLeaves, vtkTypeInt64);
  vtkGetMacro(MemorySize, int);
  vtkGetMacro(PolygonCount, vtkIdType);
  vtkGetMacro(NumberOfDataSets, int);
  vtkGetVector6Macro(Bounds, double);

  vtkTypeInt64 GetNumberOfElements(int type);

  const char* GetPrettyDataTypeString();


  vtkGetVector6Macro(Extent, int);


  vtkGetObjectMacro(PointArrayInformation, vtkPVArrayInformation);


  vtkGetObjectMacro(PointDataInformation, vtkPVDataSetAttributesInformation);
  vtkGetObjectMacro(CellDataInformation, vtkPVDataSetAttributesInformation);
  vtkGetObjectMacro(VertexDataInformation, vtkPVDataSetAttributesInformation);
  vtkGetObjectMacro(EdgeDataInformation, vtkPVDataSetAttributesInformation);
  vtkGetObjectMacro(RowDataInformation, vtkPVDataSetAttributesInformation);


  vtkGetObjectMacro(FieldDataInformation, vtkPVDataSetAttributesInformation);

  vtkPVDataSetAttributesInformation* GetAttributeInformation(int fieldAssociation);


  vtkGetObjectMacro(CompositeDataInformation, vtkPVCompositeDataInformation);

  vtkPVDataInformation* GetDataInformationForCompositeIndex(int index);

  unsigned int GetNumberOfBlockLeafs(bool skipEmpty);

  vtkPVDataInformation* GetDataInformationForCompositeIndex(int* index);


  vtkGetStringMacro(DataClassName);


  vtkGetStringMacro(CompositeDataClassName);

  vtkGetVector2Macro(TimeSpan, double);


  vtkGetMacro(HasTime, int);


  vtkGetMacro(Time, double);


  vtkGetMacro(NumberOfTimeSteps, int);


  vtkGetStringMacro(TimeLabel);

  bool IsDataStructured();

  bool IsAttributeValid(int fieldAssociation);


  vtkGetStringMacro(CompositeDataSetName);

  static void RegisterHelper(const char* classname, const char* helperclassname);

protected:
  vtkPVDataInformation();
  ~vtkPVDataInformation() override;

  void DeepCopy(vtkPVDataInformation* dataInfo, bool copyCompositeInformation = true);

  void AddFromMultiPieceDataSet(vtkCompositeDataSet* data);
  void CopyFromCompositeDataSet(vtkCompositeDataSet* data);
  void CopyFromCompositeDataSetInitialize(vtkCompositeDataSet* data);
  void CopyFromCompositeDataSetFinalize(vtkCompositeDataSet* data);
  virtual void CopyFromDataSet(vtkDataSet* data);
  void CopyFromGenericDataSet(vtkGenericDataSet* data);
  void CopyFromGraph(vtkGraph* graph);
  void CopyFromTable(vtkTable* table);
  void CopyFromHyperTreeGrid(vtkHyperTreeGrid* data);
  void CopyFromSelection(vtkSelection* selection);
  void CopyCommonMetaData(vtkDataObject*, vtkInformation*);

  static vtkPVDataInformationHelper* FindHelper(const char* classname);

  // Data information collected from remote processes.
  int DataSetType = -1;
  int CompositeDataSetType = -1;
  int NumberOfDataSets = 0;
  vtkTypeInt64 NumberOfPoints = 0; // data sets
  vtkTypeInt64 NumberOfCells = 0;
  vtkTypeInt64 NumberOfRows = 0;  // tables
  vtkTypeInt64 NumberOfTrees = 0; // hypertreegrids
  vtkTypeInt64 NumberOfVertices = 0;
  vtkTypeInt64 NumberOfEdges = 0; // graphs
  vtkTypeInt64 NumberOfLeaves = 0;
  int MemorySize = 0;
  vtkIdType PolygonCount = 0;
  double Bounds[6] = { VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX, VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX,
    VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX };
  int Extent[6] = { VTK_INT_MAX, -VTK_INT_MAX, VTK_INT_MAX, -VTK_INT_MAX, VTK_INT_MAX,
    -VTK_INT_MAX };
  double TimeSpan[2] = { VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX };
  double Time = 0.0;
  int HasTime = 0;
  int NumberOfTimeSteps = 0;

  char* DataClassName = nullptr;
  vtkSetStringMacro(DataClassName);

  char* TimeLabel = nullptr;
  vtkSetStringMacro(TimeLabel);

  char* CompositeDataClassName = nullptr;
  vtkSetStringMacro(CompositeDataClassName);

  char* CompositeDataSetName = nullptr;
  vtkSetStringMacro(CompositeDataSetName);

  vtkPVDataSetAttributesInformation* PointDataInformation;
  vtkPVDataSetAttributesInformation* CellDataInformation;
  vtkPVDataSetAttributesInformation* FieldDataInformation;
  vtkPVDataSetAttributesInformation* VertexDataInformation;
  vtkPVDataSetAttributesInformation* EdgeDataInformation;
  vtkPVDataSetAttributesInformation* RowDataInformation;

  vtkPVCompositeDataInformation* CompositeDataInformation;

  vtkPVArrayInformation* PointArrayInformation;

  friend class vtkPVDataInformationHelper;
  friend class vtkPVCompositeDataInformation;

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

  int PortNumber = -1;
};

#endif