vtkCSVExporter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCSVExporter_h
#define vtkCSVExporter_h

#include "vtkAbstractChartExporter.h"
#include "vtkPVVTKExtensionsFiltersRenderingModule.h" // needed for export macro

#include <string> // needed for std::string

class vtkAbstractArray;
class vtkDataArray;
class vtkFieldData;

class VTKPVVTKEXTENSIONSFILTERSRENDERING_EXPORT vtkCSVExporter : public vtkAbstractChartExporter
{
public:
  static vtkCSVExporter* New();
  vtkTypeMacro(vtkCSVExporter, vtkAbstractChartExporter);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);


  vtkSetStringMacro(FieldDelimiter);
  vtkGetStringMacro(FieldDelimiter);


  vtkSetMacro(Formatting, int);
  vtkGetMacro(Formatting, int);


  vtkSetMacro(Precision, int);
  vtkGetMacro(Precision, int);


  void SetColumnLabel(const char* name, const char* label);
  void ClearColumnLabels();
  const char* GetColumnLabel(const char* name);

  bool Open(ExporterModes mode = STREAM_ROWS) override;

  void Close() override;

  void Abort() override;


  void WriteHeader(vtkFieldData*) override;
  void WriteData(vtkFieldData*) override;

  void AddColumn(vtkAbstractArray* yarray, const char* yarrayname = nullptr,
    vtkDataArray* xarray = nullptr) override;

  // CVS writer does not support adding the style yet;
  void AddStyle(vtkPlot* vtkNotUsed(plot), const char* vtkNotUsed(plotName)) override{};

  void SetGlobalStyle(vtkChart* vtkNotUsed(chart)) override{};


  vtkSetMacro(WriteToOutputString, bool);
  vtkGetMacro(WriteToOutputString, bool);
  vtkBooleanMacro(WriteToOutputString, bool);

  std::string GetOutputString();

protected:
  vtkCSVExporter();
  ~vtkCSVExporter() override;

  char* FileName = nullptr;
  char* FieldDelimiter = nullptr;
  std::ostream* OutputStream = nullptr;
  ExporterModes Mode = STREAM_ROWS;

  bool WriteToOutputString = false;
  std::string OutputString;

  int Formatting;
  int Precision = 6;

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif