vtkDataWriter.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 vtkDataWriter_h
#define vtkDataWriter_h
 
#include "vtkIOLegacyModule.h" // For export macro
#include "vtkWriter.h"
 
#include <locale> // For locale settings
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCellArray;
class vtkDataArray;
class vtkDataSet;
class vtkFieldData;
class vtkGraph;
class vtkInformation;
class vtkInformationKey;
class vtkPoints;
class vtkTable;
 
class VTKIOLEGACY_EXPORT vtkDataWriter : public vtkWriter
{
public:
 
  vtkTypeMacro(vtkDataWriter, vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkDataWriter* New();
 
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
  // Currently VTK can write out two different versions of file format: files
  // of VTK reader version 4.2 and previous; and VTK reader version 5.1 and
  // later. This will likely change in the future. (Note: the major
  // difference in the two formats is the way cell arrays are written out.)
  // By default, Version 5.1 files are written out.
  enum VTKFileVersion
  {
    VTK_LEGACY_READER_VERSION_4_2 = 42,
    VTK_LEGACY_READER_VERSION_5_1 = 51
  };
 
 
  void SetFileVersion(int);
  vtkGetMacro(FileVersion, int);
  vtkGetMacro(FileMajorVersion, int);
  vtkGetMacro(FileMinorVersion, int);
 
 
  vtkSetMacro(WriteToOutputString, vtkTypeBool);
  vtkGetMacro(WriteToOutputString, vtkTypeBool);
  vtkBooleanMacro(WriteToOutputString, vtkTypeBool);
 
 
  vtkGetMacro(OutputStringLength, vtkIdType);
  vtkGetStringMacro(OutputString);
  unsigned char* GetBinaryOutputString()
  {
    return reinterpret_cast<unsigned char*>(this->OutputString);
  }
 
  vtkStdString GetOutputStdString();
 
  char* RegisterAndGetOutputString();
 
 
  vtkSetStringMacro(Header);
  vtkGetStringMacro(Header);
 
 
  vtkSetMacro(WriteArrayMetaData, bool);
  vtkGetMacro(WriteArrayMetaData, bool);
  vtkBooleanMacro(WriteArrayMetaData, bool);
 
 
  vtkSetClampMacro(FileType, int, VTK_ASCII, VTK_BINARY);
  vtkGetMacro(FileType, int);
  void SetFileTypeToASCII() { this->SetFileType(VTK_ASCII); }
  void SetFileTypeToBinary() { this->SetFileType(VTK_BINARY); }
 
 
  vtkSetStringMacro(ScalarsName);
  vtkGetStringMacro(ScalarsName);
 
 
  vtkSetStringMacro(VectorsName);
  vtkGetStringMacro(VectorsName);
 
 
  vtkSetStringMacro(TensorsName);
  vtkGetStringMacro(TensorsName);
 
 
  vtkSetStringMacro(NormalsName);
  vtkGetStringMacro(NormalsName);
 
 
  vtkSetStringMacro(TCoordsName);
  vtkGetStringMacro(TCoordsName);
 
 
  vtkSetStringMacro(GlobalIdsName);
  vtkGetStringMacro(GlobalIdsName);
 
 
  vtkSetStringMacro(PedigreeIdsName);
  vtkGetStringMacro(PedigreeIdsName);
 
 
  vtkSetStringMacro(EdgeFlagsName);
  vtkGetStringMacro(EdgeFlagsName);
 
 
  vtkSetStringMacro(LookupTableName);
  vtkGetStringMacro(LookupTableName);
 
 
  vtkSetStringMacro(FieldDataName);
  vtkGetStringMacro(FieldDataName);
 
  virtual ostream* OpenVTKFile();
 
  int WriteHeader(ostream* fp);
 
  int WritePoints(ostream* fp, vtkPoints* p);
 
  int WriteCoordinates(ostream* fp, vtkDataArray* coords, int axes);
 
  int WriteCells(ostream* fp, vtkCellArray* cells, const char* label);
 
  int WriteCellsLegacy(ostream* fp, vtkCellArray* cells, const char* label);
 
  int WriteCellData(ostream* fp, vtkDataSet* ds);
 
  int WritePointData(ostream* fp, vtkDataSet* ds);
 
  int WriteEdgeData(ostream* fp, vtkGraph* g);
 
  int WriteVertexData(ostream* fp, vtkGraph* g);
 
  int WriteRowData(ostream* fp, vtkTable* g);
 
  int WriteFieldData(ostream* fp, vtkFieldData* f);
 
  int WriteDataSetData(ostream* fp, vtkDataSet* ds);
 
  void CloseVTKFile(ostream* fp);
 
protected:
  vtkDataWriter();
  ~vtkDataWriter() override;
 
  vtkTypeBool WriteToOutputString;
  char* OutputString;
  vtkIdType OutputStringLength;
 
  void WriteData() override; // dummy method to allow this class to be instantiated and delegated to
 
  char* FileName;
  int FileVersion;
  int FileMajorVersion;
  int FileMinorVersion;
  char* Header;
  int FileType;
 
  bool WriteArrayMetaData;
 
  char* ScalarsName;
  char* VectorsName;
  char* TensorsName;
  char* TCoordsName;
  char* NormalsName;
  char* LookupTableName;
  char* FieldDataName;
  char* GlobalIdsName;
  char* PedigreeIdsName;
  char* EdgeFlagsName;
 
  std::locale CurrentLocale;
 
  int WriteArray(ostream* fp, int dataType, vtkAbstractArray* data, const char* format,
    vtkIdType num, vtkIdType numComp);
  int WriteScalarData(ostream* fp, vtkDataArray* s, vtkIdType num);
  int WriteVectorData(ostream* fp, vtkDataArray* v, vtkIdType num);
  int WriteNormalData(ostream* fp, vtkDataArray* n, vtkIdType num);
  int WriteTCoordData(ostream* fp, vtkDataArray* tc, vtkIdType num);
  int WriteTensorData(ostream* fp, vtkDataArray* t, vtkIdType num);
  int WriteGlobalIdData(ostream* fp, vtkDataArray* g, vtkIdType num);
  int WritePedigreeIdData(ostream* fp, vtkAbstractArray* p, vtkIdType num);
  int WriteEdgeFlagsData(ostream* fp, vtkDataArray* edgeFlags, vtkIdType num);
 
  bool CanWriteInformationKey(vtkInformation* info, vtkInformationKey* key);
 
  int WriteInformation(ostream* fp, vtkInformation* info);
 
private:
  vtkDataWriter(const vtkDataWriter&) = delete;
  void operator=(const vtkDataWriter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif