vtkJSONDataSetWriter.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 vtkJSONDataSetWriter_h
#define vtkJSONDataSetWriter_h

#include "vtkIOExportModule.h" // For export macro

#include "vtkWriter.h"

#include <string> // std::string used as parameters in a few methods

#include "vtkDataArraySelection.h" // Instantiated
#include "vtkNew.h"                // Used for DataArray selection

VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
class vtkDataArray;
class vtkDataSetAttributes;
class vtkArchiver;
struct vtkJSONDataSetWriterFunctor;

class VTKIOEXPORT_EXPORT vtkJSONDataSetWriter : public vtkWriter
{
public:
  using vtkWriter::Write;


  static void ComputeMD5(const unsigned char* content, int size, std::string& hash);


  static std::string GetShortType(vtkDataArray* input, bool& needConversion);


  static std::string GetUID(vtkDataArray*, bool& needConversion);


  std::string GetValidString(const char*);


  bool WriteArrayContents(vtkDataArray*, VTK_FILEPATH const char* relativeFilePath);


  static bool WriteArrayAsRAW(vtkDataArray*, VTK_FILEPATH const char* filePath);

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


  vtkDataSet* GetInput();
  vtkDataSet* GetInput(int port);


  virtual void SetArchiver(vtkArchiver*);
  vtkGetObjectMacro(Archiver, vtkArchiver);

  vtkGetObjectMacro(PointArraySelection, vtkDataArraySelection);

  vtkGetObjectMacro(CellArraySelection, vtkDataArraySelection);

  void Write(vtkDataSet*);

  bool IsDataSetValid() { return this->ValidDataSet; }

protected:
  vtkJSONDataSetWriter();
  ~vtkJSONDataSetWriter() override;

  bool WriteDataAndReturn() final;
  std::string WriteArray(vtkDataArray*, const char* className, const char* arrayName = nullptr);
  std::string WriteDataSetAttributes(vtkDataSetAttributes* fields, const char* className);

  vtkArchiver* Archiver;
  bool ValidDataSet;
  int ValidStringCount;

  int FillInputPortInformation(int port, vtkInformation* info) override;

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

  vtkNew<vtkDataArraySelection> PointArraySelection;
  vtkNew<vtkDataArraySelection> CellArraySelection;

  friend struct vtkJSONDataSetWriterFunctor;
};

VTK_ABI_NAMESPACE_END
#endif