VTK  9.0.2
vtkFieldDataSerializer.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkFieldDataSerializer.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14  =========================================================================*/
28 #ifndef vtkFieldDataSerializer_h
29 #define vtkFieldDataSerializer_h
30 
31 #include "vtkObject.h"
32 #include "vtkParallelCoreModule.h" // For export macro
33 
34 // Forward declarations
35 class vtkIdList;
36 class vtkFieldData;
37 class vtkDataArray;
38 class vtkStringArray;
39 class vtkIntArray;
41 
42 class VTKPARALLELCORE_EXPORT vtkFieldDataSerializer : public vtkObject
43 {
44 public:
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
53  static void SerializeMetaData(vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);
54 
67  static void DeserializeMetaData(vtkMultiProcessStream& bytestream, vtkStringArray* names,
68  vtkIntArray* datatypes, vtkIntArray* dimensions);
69 
73  static void Serialize(vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);
74 
78  static void SerializeTuples(
79  vtkIdList* tupleIds, vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);
80 
87  static void SerializeSubExtent(
88  int subext[6], int gridExtent[6], vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);
89 
96  int subext[6], int gridExtent[6], vtkFieldData* fieldData, vtkMultiProcessStream& bytestream);
97 
101  static void Deserialize(vtkMultiProcessStream& bytestream, vtkFieldData* fieldData);
102 
103 protected:
106 
111  static vtkDataArray* ExtractSelectedTuples(vtkIdList* tupleIds, vtkDataArray* inputDataArray);
112 
118  int subext[6], int gridExtent[6], vtkDataArray* inputDataArray);
119 
123  static void SerializeDataArray(vtkDataArray* dataArray, vtkMultiProcessStream& bytestream);
124 
128  static void DeserializeDataArray(vtkMultiProcessStream& bytestream, vtkDataArray*& dataArray);
129 
130 private:
132  void operator=(const vtkFieldDataSerializer&) = delete;
133 };
134 
135 #endif /* vtkFieldDataSerializer_h */
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
A concrete instance of vtkObject which provides functionality for serializing and de-serializing fiel...
static void SerializeDataArray(vtkDataArray *dataArray, vtkMultiProcessStream &bytestream)
Serializes the data array into a bytestream.
static void DeSerializeToSubExtent(int subext[6], int gridExtent[6], vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
Deserializes the field data from a bytestream to a the given sub-extent.
static vtkDataArray * ExtractSelectedTuples(vtkIdList *tupleIds, vtkDataArray *inputDataArray)
Given an input data array and list of tuples, it extracts the selected tuples in to a new array and r...
static void SerializeMetaData(vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
Serializes the metadata of the given field data instance, i.e., the number of arrays,...
~vtkFieldDataSerializer() override
static void DeserializeMetaData(vtkMultiProcessStream &bytestream, vtkStringArray *names, vtkIntArray *datatypes, vtkIntArray *dimensions)
Given the serialized field metadata in a bytestream, this method extracts the name,...
static void SerializeSubExtent(int subext[6], int gridExtent[6], vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
Serializes the given sub-extent of field data of a structured grid in a byte-stream.
static void Deserialize(vtkMultiProcessStream &bytestream, vtkFieldData *fieldData)
Deserializes the field data from a bytestream.
static vtkFieldDataSerializer * New()
static vtkDataArray * ExtractSubExtentData(int subext[6], int gridExtent[6], vtkDataArray *inputDataArray)
Given an input data array corresponding to a field on a structured grid, extract the data within the ...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void Serialize(vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
Serializes the given field data (all the field data) into a bytestream.
static void DeserializeDataArray(vtkMultiProcessStream &bytestream, vtkDataArray *&dataArray)
Deserializes the data array from a bytestream.
static void SerializeTuples(vtkIdList *tupleIds, vtkFieldData *fieldData, vtkMultiProcessStream &bytestream)
Serializes the selected tuples from the field data in a byte-stream.
represent and manipulate fields of data
Definition: vtkFieldData.h:54
list of point or cell ids
Definition: vtkIdList.h:31
a simple class to control print indentation
Definition: vtkIndent.h:34
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:40
stream used to pass data across processes using vtkMultiProcessController.
abstract base class for most VTK objects
Definition: vtkObject.h:63
a vtkAbstractArray subclass for strings