vtkFieldDataSerializer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkFieldDataSerializer_h
#define vtkFieldDataSerializer_h

#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_6_0
#include "vtkObject.h"
#include "vtkParallelCoreModule.h" // For export macro

// Forward declarations
VTK_ABI_NAMESPACE_BEGIN
class vtkIdList;
class vtkFieldData;
class vtkDataArray;
class vtkStringArray;
class vtkIntArray;
class vtkMultiProcessStream;

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

  static void SerializeMetaData(vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);

  static void DeserializeMetaData(vtkMultiProcessStream& bytestream, vtkStringArray* names,
    vtkIntArray* datatypes, vtkIntArray* dimensions);

  static void Serialize(vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);

  static void SerializeTuples(
    vtkIdList* tupleIds, vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);

  static void SerializeSubExtent(
    int subext[6], int gridExtent[6], vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);

  static void DeSerializeToSubExtent(
    int subext[6], int gridExtent[6], vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);

  static void Deserialize(vtkMultiProcessStream& bytestream, vtkFieldData* fieldData);

protected:
  vtkFieldDataSerializer();
  ~vtkFieldDataSerializer() override;

  static vtkDataArray* ExtractSelectedTuples(vtkIdList* tupleIds, vtkDataArray* inputDataArray);

  static vtkDataArray* ExtractSubExtentData(
    int subext[6], int gridExtent[6], vtkDataArray* inputDataArray);

  VTK_DEPRECATED_IN_9_6_0("Use vtkMultiProcessStream::Push(vtkDataArray*) instead.")
  static void SerializeDataArray(vtkDataArray* dataArray, vtkMultiProcessStream& bytestream);

  VTK_DEPRECATED_IN_9_6_0("Use vtkMultiProcessStream::Pop(vtkDataArray*&) instead.")
  static void DeserializeDataArray(vtkMultiProcessStream& bytestream, vtkDataArray*& dataArray);

private:
  vtkFieldDataSerializer(const vtkFieldDataSerializer&) = delete;
  void operator=(const vtkFieldDataSerializer&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif /* vtkFieldDataSerializer_h */