vtkJSONDataSetWriter.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkJSONDataSetWriter.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkJSONDataSetWriter_h
#define vtkJSONDataSetWriter_h
 
#include "vtkIOExportModule.h" // For export macro
 
#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_0_0
#include "vtkWriter.h"
 
#include <string> // std::string used as parameters in a few methods
 
class vtkDataSet;
class vtkDataArray;
class vtkDataSetAttributes;
class vtkArchiver;
 
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;
 
 
  VTK_DEPRECATED_IN_9_0_0("Use vtkJSONDataSetWriter::SetArchiveName")
  void SetFileName(VTK_FILEPATH const char*);
  VTK_DEPRECATED_IN_9_0_0("Use vtkJSONDataSetWriter::GetArchiveName")
  virtual VTK_FILEPATH char* GetFileName();
 
 
  vtkDataSet* GetInput();
  vtkDataSet* GetInput(int port);
 
 
  virtual void SetArchiver(vtkArchiver*);
  vtkGetObjectMacro(Archiver, vtkArchiver);
 
  void Write(vtkDataSet*);
 
  bool IsDataSetValid() { return this->ValidDataSet; }
 
protected:
  vtkJSONDataSetWriter();
  ~vtkJSONDataSetWriter() override;
 
  void WriteData() 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;
};
 
#endif