vtkDelimitedTextWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2009 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkDelimitedTextWriter_h
#define vtkDelimitedTextWriter_h

#include "vtkIOCoreModule.h" // For export macro
#include "vtkWriter.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkStdString;
class vtkTable;

class VTKIOCORE_EXPORT vtkDelimitedTextWriter : public vtkWriter
{
public:
  static vtkDelimitedTextWriter* New();
  vtkTypeMacro(vtkDelimitedTextWriter, vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetStringMacro(FieldDelimiter);
  vtkGetStringMacro(FieldDelimiter);


  vtkSetStringMacro(StringDelimiter);
  vtkGetStringMacro(StringDelimiter);


  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);


  vtkSetMacro(UseStringDelimiter, bool);
  vtkGetMacro(UseStringDelimiter, bool);


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

  char* RegisterAndGetOutputString();

  vtkStdString GetString(vtkStdString string);


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

  enum Notations
  {
    STANDARD_NOTATION = 0,
    SCIENTIFIC_NOTATION,
    FIXED_NOTATION
  };


  vtkSetMacro(Notation, int);
  vtkGetMacro(Notation, int);
  virtual void SetNotationToStandard() { this->SetNotation(STANDARD_NOTATION); }
  virtual void SetNotationToScientific() { this->SetNotation(SCIENTIFIC_NOTATION); }
  virtual void SetNotationToFixed() { this->SetNotation(FIXED_NOTATION); }

protected:
  vtkDelimitedTextWriter();
  ~vtkDelimitedTextWriter() override;

  bool WriteToOutputString;
  char* OutputString;

  bool OpenStream();

  bool WriteDataAndReturn() override;

  // see algorithm for more info.
  // This writer takes in vtkTable.
  int FillInputPortInformation(int port, vtkInformation* info) override;

  char* FileName;
  char* FieldDelimiter;
  char* StringDelimiter;
  bool UseStringDelimiter;
  int Precision = 6;
  int Notation = STANDARD_NOTATION;

  ostream* Stream;

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

  bool WriteTable(vtkTable* table);
};

VTK_ABI_NAMESPACE_END
#endif